https://github.com/morishjs/quill-markdown-toolbar

A Quill.js module for converting markdown text to rich text format
https://github.com/morishjs/quill-markdown-toolbar

conversion converter javascript markdown quill quilljs text-editor

Last synced: 8 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/morishjs/quill-markdown-toolbar
• Owner: morishjs
• License: mit
• Created: 2019-02-12T13:54:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T22:15:49.000Z (almost 2 years ago)
• Last Synced: 2024-08-11T17:08:18.074Z (3 months ago)
• Topics: conversion, converter, javascript, markdown, quill, quilljs, text-editor
• Language: CSS
• Homepage:
• Size: 4.55 MB
• Stars: 17
• Watchers: 4
• Forks: 9
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-quill - quill-markdown-toolbar - A Quill.js module for converting markdown text to rich text format (Uncategorized / Uncategorized)

README

        
# quill-markdown-toolbar

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

# Quickstart

## Install using npm

```shell

npm i quill-markdown-toolbar

```

## Install using CDN

```html

```

## Register a module

```html

<script src="https://cdn.quilljs.com/1.3.1/quill.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.

    }

  });

  

  

```

# Demo

Paste markdown text and click the markdown button on toolbar. 


![](https://media.giphy.com/media/YWoBHJ32QqTOFRQzue/giphy.gif)

# 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