4 ms·
My sense is the markdown/git/render a documentation wiki with mkdocs is mostly solved. The issue is having that easy interface for non-tech folk. And related t
by evolve2k 4y ago
My sense is the markdown/git/render a documentation wiki with mkdocs is mostly solved. The issue is having that easy interface for non-tech folk.
And related to this is the state of WYSIWYG markdown editing.
The Basecamp folks created the very polished Trix rich-text drop-in which is a replacement for TinyMce, which while the standard seems to carry issues.
Basecamp explained the issue with most approaches as such:
> Most WYSIWYG editors are wrappers around HTML’s contenteditable and execCommand APIs, designed by Microsoft to support live editing of web pages in Internet Explorer 5.5, and eventually reverse-engineered and copied by other browsers.
> Because these APIs were never fully specified or documented, and because WYSIWYG HTML editors are enormous in scope, each browser’s implementation has its own set of bugs and quirks, and JavaScript developers are left to resolve the inconsistencies.
> Trix sidesteps these inconsistencies by treating contenteditable as an I/O device: when input makes its way to the editor, Trix converts that input into an editing operation on its internal document model, then re-renders that document back into the editor. This gives Trix complete control over what happens after every keystroke, and avoids the need to use execCommand at all.
Unfortunately Trix does not render markdown so can’t be used in a markdown documentation workflow.
Has anyone seen a decent implementation of WYSIWYG for markdown that has the necessary polish to be non-tech friendly?
- rcarr 4y agoI believe Obsidian are using ProseMirror or CodeMirror, the logo is at the bottom of CodeMirror so I assume it is the latter. There was this forum post from one of the Obsidian team a few years back asking about it https://discuss.codemirror.net/t/implementing-wysiwyg-markdown-editor-in-codemirror/2403 https://discuss.codemirror.net/t/implementing-wysiwyg-markdo... https://codemirror.net https://codemirror.net https://prosemirror.net https://prosemirror.net
- andfrob 4y agoThis would be worth checking out, which shows how CKEditor implements markdown editing: https://onlinemarkdowneditor.dev/ https://onlinemarkdowneditor.dev/
- Marta_B 4y agoYes, CKEditor accepts Markdown input thanks to a customizable autoformatting feature: https://ckeditor.com/docs/ckeditor5/latest/features/autoformat.html https://ckeditor.com/docs/ckeditor5/latest/features/autoform... This allows users to employ all the familiar shortcodes on the go. It's basically the user's choice whether to type in Markdown or use the rich-text formatting buttons. Additionally, it's possible to switch the default CKEditor 5 output from HTML to Markdown: https://ckeditor.com/docs/ckeditor5/latest/features/markdown.html https://ckeditor.com/docs/ckeditor5/latest/features/markdown...