Skip to content

A Quill.js module for converting markdown text to rich text format

License

Notifications You must be signed in to change notification settings

morishjs/quill-markdown-toolbar

Repository files navigation

quill-markdown-toolbar

Quill.js module that converts pasted markdown to rich text formatting.

Quickstart

Install using npm

npm i quill-markdown-toolbar

Install using CDN

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/markdownToolbar.min.js">

Register a module

<script src="https://cdn.quilljs.com/1.3.1/quill.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/markdownToolbar.min.js">
<script>
  const toolbarOptions = {
      container: [
        ['bold', 'italic', 'underline', 'strike'],
        ['markdown'], // Add this.
      ],
      handlers: { // Add this.
      'markdown': function () {} 
      }
    };

  var quill = new Quill('#editor', {
    theme: 'snow',
    modules: {
      toolbar: toolbarOptions,
      'markdown-toolbar': true // Add this.
    }
  });
</script>  
  

Demo

Paste markdown text and click the markdown button on toolbar.

Try yourself!

If you are a visual studio code user, you can run on debug tab.

Contribution

  • For now, use the Github issues for requests/bug issues
    • Reporting new bugs or adding details to existing ones
    • Reproducing unconfirmed bugs
    • Requesting new features

License

MIT License