jlvandenhout / docusaurus-plugin-docs-editor

56 stars 13 forks source link

Better Editing Experience #31

Open austincondiff opened 3 years ago

austincondiff commented 3 years ago

Imagine the user clicks "Edit" and the left sidebar expands and turns into an editor. The page content becomes your preview area and updates with the users changes. This allows the user to see exactly what their edits will look like when everything is saved which will prevent unnecessary correction edits.

I also think that markdown is the bread and butter if you will of Docusaurus. With this in mind, I think that this should be the highlight of the editing experience rather than making it a simple WYSIWYG editor. I am thinking something more in line with iA Writer (or even this very GitHub markdown text input) where we focus on writing in markdown but provide familiar toolbar buttons that help users format who may not yet be familiar with markdown syntax. This encourages users to learn markdown as they go without impeding anything they need to do.

I was thinking the editor could look like this.

Rich Text View

docusaurus-editor-rich-text

Markdown View

docusaurus-editor-markdown

Split View

docusaurus-editor-split

The design is more consistent with the rest of Docusaurus. It also has three distinct views that cater to different users. If a user prefers editing in markdown they can.