CodeMirror 6 Quickstart and Learn-By-Examples

https://github.com/RPGillespie6/codemirror-quickstart/tree/master

This was very useful for me, I could not get started with the official documentation…

@marijn While the CM6 is an amazing piece of software the documentation clearly suffers the Curse of knowledge - Wikipedia.

The tutorials on the page are great for when someone already knows the basics, but the documentation really lacks a few clearly marked and easy to find complete examples for newbies like this one. Reading how the core is functional and the shell is imperative or the whole api documentation while I don’t understand how to glue this editor together to make it even work is impractical.

In your first response to the original post you said that the examples don’t provide anything more than is already written and shared two links. I’ve read both of the pages yet still couldn’t figure out basic stuff while reading the first example code from OP gave me everything to get going.

In my case the main problem was that I don’t really know where the “built-in” extensions come from. The pages list all the extensions but I couldn’t find them because I have no idea what modules to import them from. While I still have no idea how to find it - the example from OP showed me this in code and this is fine for me right now.

What I’m trying to say is that I’d appreciate if you reconsidered the matter of documentation from the perspective of total newbie. I know it’s hard due to aforementioned curse of knowledge, but I believe this thread highlights our perspective quite well. The only question is - are you willing to help more people embrace CM6 by providing clear “getting started” guide?

To clarify my original reply to this thread: I am happy that this quickstart was written, and it’s great if such resources exist. I just don’t want to move them into the project website because trying to explain the messy JS ecosystem from scratch adds a lot of scope, and I don’t want to be responsible for publishing and maintaining such a document. Also, I feel that people who are completely new to JS development are simply unlikely to have a good time with CodeMirror. It is a large, complex library that requires a certain amount of development background for people to be able to do anything useful with it. As such, catering to beginning programmers is not something that feels like a good use of my energy. But again, if others want to write guides in this space, more power to them.

I understand this point of view - especially about the maintenance. Those are valid points.

I’d like to clarify one thing a bit. My post was not about tutorials for beginner programmers. What I needed was a basic piece of code that shows the complete setup of CodeMirror. I literally lacked this - I’d probably be okay with even more minimal setup. Just basics showing the API of codemirror to get me started.

Using this example I managed to integrate CM6 into my app and I’m pretty happy with the results. Just needed something to jumpstart from. Maybe you could at least consider additional section on the page with links to external resources with “warranty off” notice? I feel like this could help others (non-beginners as well) get started with CM6.

Whatever you decide - I’ll take this opportunity to thank you for the work on CM6. I’ve my experience with few different editors in different technologies (non-JS/non-browser envs) and I know how terrible the experience can get. This lets me fully appreciate the architecture you’ve designed for CM6. Thank you for this!