shiki icon indicating copy to clipboard operation
shiki copied to clipboard

💡 Shiki Editor

Open magic-akari opened this issue 5 months ago • 1 comments

Hello, I am amazed by the powerful extensibility of Shiki. I have created a lightweight code editor using Shiki and a textarea.

This editor utilizes a textarea for input, leverages Shiki for code highlighting, and incorporates functionalities such as tab key indentation and auto insertion of matching brackets.

You can explore the playground of this editor by visiting the following link: Shiki Editor Playground

I am planning to release this editor as an npm package, but I am unsure if there is interest in it, so I am seeking feedback.

Here is the repository source code: https://github.com/magic-akari/shiki-editor

Moreover, I am interested to inquire whether the Shiki team would be open to including this editor within the Shiki organization.

magic-akari avatar Mar 24 '24 06:03 magic-akari

That looks nice, but unfortunately, I don't think we could make this official at this moment:

  • The repo you linked seems to be at quite an early stage, I think it would be better if it can have some docs to describe how to use it etc.
  • "and incorporates functionalities such as tab key indentation and auto insertion of matching brackets" - there are nice - but I am concerned about the scope in the future, knowing that creating a code editor is super challenging (even tho we might not going to create another Codemirror or Monaco, we still need to figure out the line what feature request we should take)

I am happy to link to your project in our docs if you could write some readme guides for it - later, if it's verified by the community that's a common need; we could then discuss again about whether to move to the org. Thank you.

antfu avatar Mar 25 '24 08:03 antfu

Similarly, I would like to thank antfu for your work on Shiki, and also thank magic-akari for inspiring me in this matter. Over the past half month, I have done some minor work to systematize the ideas of shiki-editor and have been developing it as a project for some time. Now, I can provide a small core library for users to use, while also offering enhanced editing functionality as plugins, as mentioned by magic-akari above. Users can selectively use the parts they need. I have now released the first pre-release of this project and provided some documentation on how to use it in the README.md. If anyone is interested, you can find it here. This project may be a long-term challenge for me, so I have planned some tasks to complete it. If anyone is interested in this project, feel free to initiate a PR to contribute.

image

NWYLZW avatar Mar 31 '24 20:03 NWYLZW