tui-editor
Advanced tools
GFM Markdown Wysiwyg Editor - Productive and Extensible
Standard and Extensible
Today CommonMark is the de-facto Markdown standard. And GFM (GitHub Flavored Markdown) is another popular specification based on CommonMark maintained by GitHub which is known as the biggest Markdown user. ToastUI Editor respects CommonMark and GFM specifications. Write documents with easy and productive tools provided by ToastUI Editor. You can open this document wherever the specifications are supported.
CommonMark and GFM are great, but we often face requirements beyond the specifications. The ToastUI Editor comes with powerful Extensions in compliance with the Markdown syntax. And it also provides APIs so you can develop your own extensions. Please check here to learn about Extensions.
Here are some of extensions which you can start right on.
Here you can find and more
ToastUI Editor provides Markdown mode and Wysiwyg mode.
Someone may like the productivity of Markdown, but the other can be looking for a way to make it easier to edit. The ToastUI Editor can be the coordinator of both. It offers Markdown mode and Wysiwyg mode, those can be switched at any time during writing content. Work together conveniently in one document.
npm install --save tui-editor
bower install --save tui-editor
Below codes are for npm. If you are using bower please see Getting started with bower.
Place a <div></div> where you want ToastUI Editor rendered.
<body>
...
<div id="editSection"></div>
...
</body>
Initialize Editor class with given element to make an Editor.
var Editor = require('tui-editor');
...
var editor = new Editor({
el: document.querySelector('#editSection'),
initialEditType: 'markdown',
previewStyle: 'vertical',
height: '300px'
});
or you can use jquery plugin.
$('#editSection').tuiEditor({
initialEditType: 'markdown',
previewStyle: 'vertical',
height: '300px'
});
300px | automarkdown | wysiwygtab | verticalFind out more options here
ToastUI Editor provides a Viewer in case you want to show Markdown content without loading the editor. The Viewer has much lighter than the editor.
var Viewer = require('tui-editor/dist/tui-editor-Viewer');
...
var editor = new Viewer({
el: document.querySelector('#viewerSection'),
height: '500px',
initialValue: '# content to be rendered'
});
...
Be careful not to load both the editor and the viewer. Since the editor already includes the viewer function, you can initialize editor by calling Editor.factory() with viewer option true value to make the editor a viewer. You can also call getHTML() to get rendered HTML string.
var Editor = require('tui-editor');
...
var editor = Editor.factory({
el: document.querySelector('#viewerSection'),
viewer: true,
height: '500px',
initialValue: '# content to be rendered'
});
...
ToastUI Editor respects CommonMark and GFM. So any Markdown renderer including markdownit can handle the content it made. You can use any of those renderer without Viewer if you want.
 Internet Explorer |  Edge |  Firefox |  Chrome |  Safari |
|---|---|---|---|---|
| 10+ | Yes | Yes | Yes | Yes |
FAQs
GFM Markdown Wysiwyg Editor - Productive and Extensible
We found that tui-editor demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.