WYSIWYG editor #2404
Replies: 4 comments 6 replies
-
|
I could see this being popular with Turing Way contributors. I believe a lot of our contributors use the GitHub interface to edit files, which is a bit of a poor experience. Something like this which is in-browser but also not trying to be an IDE, like the VSCode-like offering on GitHub, could suit them quite well. I think I would still recommend people take the time to learn MyST Markdown though, to take advantage of all of the features. We did also talk @rlanzafame about using something like editing in JupyterHub with live previews. That is a different idea though. |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
I am going to create a new Discussion to describe the tool needed for GitHub authentication in JupyterLab. Let's keep this discussion going but focus on the editing side of things. Specifically, this is a list of requirements brainstormed by @fperez at the sprint. It is part of a user story we will document elsewhere. The key thing is to make sure the user editing experience in a ipynb or md file is first class. It does not explicitly need to be WYSIWYG, but WYSIWYM..."what you mean," similar to the LyX processor for LaTeX. It should be semantically correct; it does not need to get the style of the entire book right. It focuses on the contents of a page; user would need a myst build when checking things at book scale. Features to consider (i think not mutually exclusive...not my area of expertise!):
Some items in this list can be checked with/transferred to issues in the Jupyter Lab Extension repo. |
Beta Was this translation helpful? Give feedback.

Uh oh!
There was an error while loading. Please reload this page.
-
TeachBooks has a functioning WYSIWYG app that was developed by a group of students at Delft last Spring. It might be interesting for JB2 (and already works for JB1). I will start with a brief explanation and some useful links. Later I will try to post a video demonstrating usage of the tool.
The tool (we called it the TeachBooks Wizard) currently works in JB1 as a Sphinx extension: an "edit this book" button is added, then the WYSIWYG interface is activated. I presume this would need to be implemented as a plugin for JB2. Edits to the source code are committed to the repository (using a PAT for authentication/access); the user can choose which branch to commit to, and write the commit message. The design perspective focuses on supporting a particular user type: those that are learning about JB and the related tools (git, python, etc) and lowering the barrier to contribute to a book as much as possible. The intention was also to endow the tool with tips and hints to help users learn how to be more independent.
@ryanlovett @fperez @JimMadge
Beta Was this translation helpful? Give feedback.
All reactions