-
Notifications
You must be signed in to change notification settings - Fork 139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a WYSIWYG-esque editor for instructions #1394
Comments
@outoftime I'm a ScriptEd volunteer browsing some issues for tomorrow's hack day. I notice that I am already able to edit instructions using markdown, so was wondering how this is different? |
@meg2208 nice, love to see the advanced reconnaissance! Right now the instructions editing capability just uses a plain |
thanks for the explanation! I get it now. Seems like this could be a good thing to work on tonight. I think it shouldn't be a problem to async load those dependencies, but I could be missing something. Also, re CodeMirror vs Ace I'm still reading up on that, but this guy seems to like Ace better and it seems to be slightly more battle tested (probably mostly cuz it has been around longer). Perhaps this might be fixing something that aint broke, but I could be convinced. |
@meg2208 the only complication with async loading is that the editor library will be a dependency of an actual React component, which isn’t something we have done before, but I’m sure there are good libraries out there to deal with the issue (and I believe native support is coming to React). ACE is great in a lot of ways, but there are a couple reasons I’ve long thought switching to something else might be good:
That said any switch to another editor (and we should probably at least look at CodeFlask, Monaco, etc. as well) is definitely in the realm of conjecture/exploration at the moment. |
I'm working on a PR for this using SimpleMDE (via react plugin: since we are using https://github.com/RIP21/react-simplemde-editor). Not sure exactly when it will be finished because this is my first forray into this project, but it's in progress and shouldn't be more than a couple weeks, if that. I can open the PR early if I have questions. |
There are good pseudo-WYSIWYG editors (e.g.
**bold text**
is displayed bold etc.) for Markdown out there. A couple of good looking options are SimpleMDE and TOAST UI Editor, although both use CodeMirror rather than ACE (we use the latter for the main editors so it would be nice to share the dependency, although this is not a deal breaker).Note that one thing we don’t want to do is load a Markdown editor library synchronously as part of the initial pageload—I think we will want to load it async and only if/when editing mode is activated. This might be a little tricky, especially before React releases support for async components, but I’m happy to share some ideas.
The text was updated successfully, but these errors were encountered: