node package manager



GFM Markdown WYSIWYG Editor - Productive and Extensible

github version npm version bower version license PRs welcome code with hearth by NHN ent.

ūüö© Table of Contents

ūüĆŹ Browser Support

IE / Edge Internet Explorer IE / Edge Edge Firefox Firefox Chrome Chrome Safari Safari
10+ Yes Yes Yes Yes

Standard and Extensible

standard and extensible image

CommonMark + GFM Specifications

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.

Powerful Extensions

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:

  • Color picker: ColorPicker provides an easy way to color text with a GUI tool box
  • Chart code block: A Code block marked as a 'chart' will render charts
  • UML code block: A Code block marked as an 'uml' will render UML diagrams
  • Table merge: You can merge columns and rows in tables

To learn more about Extensions check the Using Extension

ūüé® Features

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.

Productive Markdown mode

markdown image

  • Live Preview: Edit Markdown while keeping eye on the rendered HTML. Your edits will be applied immediately
  • Scrolling Sync: Synchronous scrolling between Markdown and Preview. You don't need to scroll those separately
  • Auto indent: The cursor will always be where you want to be
  • Syntax highlight: You can check broken Markdown syntax immediately

Easy WYSIWYG mode

wysiwyg image

  • Copy and paste: Paste anything from browser, screenshot, excel, powerpoint etc
  • Codeblock editor: Highlight 170+ languages with full size code editor
  • Table: Hate the Markdown table? You can do everything with a mouse

And more

  • i18n: English, Dutch, Korean, Japanese, Chinese, Spanish, German, Russian, French, Ukrainian + language you extend.
  • Viewer: Renders Markdown content with extensions

ūüíĺ Install

using npm

npm install --save tui-editor

using bower

bower install --save tui-editor


ūüĒ® Usage

The code provided underneath is for npm + bundler. If you are using bower please see Getting started with bower.



Place a <div></div> where you want TOAST UI Editor rendered.

<div id="editSection"></div>


Add dependencies & initialize Editor class with given element to make an Editor.

// deps for editor
require('codemirror/lib/codemirror.css') // codemirror
require('tui-editor/dist/tui-editor.css'); // editor ui
require('tui-editor/dist/tui-editor-contents.css'); // editor content
require('highlight.js/styles/github.css'); // code block highlight
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.

    initialEditType: 'markdown',
    previewStyle: 'vertical',
    height: '300px'


  • height: Height in string or auto ex) 300px | auto
  • initialValue: Initial value. Set Markdown string
  • initialEditType: Initial type to show markdown | wysiwyg
  • previewType: Preview style of Markdown mode tab | vertical

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.
require('tui-editor/dist/tui-editor-contents.css'); // editor content
require('highlight.js/styles/github.css'); // code block highlight
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 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 = require('tui-editor');
var editor = Editor.factory({
    el: document.querySelector('#viewerSection'),
    viewer: true,
    height: '500px',
    initialValue: '# content to be rendered'

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.

ūüďô Docs

ūüźĺ Examples

ūüí¨ Contributing

ūüćě TOAST UI Family

ūüöÄ Used By

ūüďú License

This software is licensed under the MIT © NHN Ent.