@devforth/quill-markdown-shortcuts

Quill.js module that converts markdown to rich text formatting while typing.

0.0.12
latest
npm

Version published: 4 years ago

Maintainers: 2

Created: 4 years ago

Source

Quill Markdown Shortcuts

This package is a Quill.js module that converts markdown on the fly to formatted rich text.

Quickstart

Installation

Using NPM

Use the NPM package manager to add this dependency to your project.

npm i -S @devforth/quill-markdown-shortcuts

By downloading file

To incorporate the code into your codebase, simply download the markdownShortcuts.js file and include that in your build process or link a script tag to it directly. Then set up quill and make sure to include the markdownShortcuts setting in modules.

Usage

ES6

import Quill from 'quill';
import MarkdownShortcuts from 'quill-markdown-shortcuts';

Quill.register('modules/markdownShortcuts', MarkdownShortcuts);

const quill = new Quill('#editor', {
  theme: 'snow',
  // All you need to do to enable the module is to add a modules key
  // to your quill configuration, and add markdownShortcuts with an
  // empty object.
  // There are currently no options to set.
  modules: {
    markdownShortcuts: {}
  }
});

Script Tag

<body>
  <div class="container">
    <div id="editor"></div>
    <script src="/path/to/node_modules/quill-markdown-shortcuts/dist/markdownShortcuts.js"></script>
    <script>
      var quill = new Quill('#editor', {
        theme: 'snow',
        // All you need to do to enable the module is to add a modules key
        // to your quill configuration, and add markdownShortcuts with an
        // empty object.
        // There are currently no options to set.
        modules: {
          markdownShortcuts: {}
        }
      });
    </script>
  </div>
</body>

Contributing

Issues and pull requests are welcome!

Building the module and examples

To build the module and the example bundles, please run npm run build and include the bundles in your commit. Thanks!

FAQs

What is @devforth/quill-markdown-shortcuts?

Is @devforth/quill-markdown-shortcuts well maintained?

Package last updated on 27 Jan 2021

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.

Install