GFM Markdown WYSIWYG Editor - Productive and Extensible
Today CommonMark is the de-facto Markdown standard. GFM (GitHub Flavored Markdown) is another popular specification based on CommonMark - maintained by GitHub, which is the Markdown mostly used. TOAST UI Editor respects both CommonMark and GFM specifications. Write documents with ease using productive tools provided by TOAST UI Editor and you can easily open the produced document wherever the specifications are supported.
CommonMark and GFM are great, but we often need more abstraction. The TOAST UI Editor comes with powerful Extensions in compliance with the Markdown syntax. You also get the flexibility to develop your own extensions using simple APIs.
Here are some of the extensions you can start with:
To learn more about Extensions check the Using Extension
TOAST UI Editor provides Markdown mode and WYSIWYG mode.
Depending on the type of use you want like production of Markdown or maybe to just edit the Markdown. The TOAST UI Editor can be helpful for both the usage. It offers Markdown mode and WYSIWYG mode, which can be switched any point in time.
npm install --save tui-editor
bower install --save tui-editor
The code provided underneath is for npm + bundler. If you are using bower please see Getting started with bower.
<div></div> where you want TOAST UI Editor rendered.
Add dependencies & initialize Editor class with given element to make an Editor.
// deps for editor// codemirror; // editor ui; // editor content; // code block highlightvar Editor = ;...var editor =el: documentinitialEditType: 'markdown'previewStyle: 'vertical'height: '300px';
or you can use jquery plugin.
Find out more options here
TOAST UI Editor provides a Viewer in case you want to show Markdown content without loading the editor. The Viewer is much lighter than the editor.
// deps for viewer.; // editor content; // code block highlightvar Viewer = ;...var editor =el: documentheight: '500px'initialValue: '# content to be rendered';...
Be careful not to load both the editor and the viewer at the same time because the editor already contains the viewer function, you can initialize editor Editor.factory() and set the
viewer option to value
true in order to make the editor a viewer. You can also call getHTML() to render the HTML.
var Editor = ;...var editor = Editor;...
TOAST UI Editor respects CommonMark and GFM. So any Markdown renderer including markdownit can handle the content made using TOAST UI Editor. You can also use any of these renderer in place of TOAST UI Editor Viewer.