quill-markdown-shortcuts
Advanced tools
Quill.js module that converts markdown to rich text formatting while typing.
This package is a Quill.js module that converts markdown on the fly to formatted rich text.
Use the NPM package manager to add this dependency to your project.
npm i -S quill-markdown-shortcuts
Add the library via jsdelivr.
<script src="https://cdn.jsdelivr.net/npm/quill-markdown-shortcuts@latest/dist/markdownShortcuts.js">
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.
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: {}
}
});
<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>
Issues and pull requests are welcome! Please open an issue for all other inquiries.
To build the module and the example bundles, please run npm run build and include the bundles in your commit. Thanks!
FAQs
Quill.js module that converts markdown to rich text formatting while typing.
The npm package quill-markdown-shortcuts receives a total of 1,076 weekly downloads. As such, quill-markdown-shortcuts popularity was classified as popular.
We found that quill-markdown-shortcuts 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.
Research
/Security News
A flawed sandbox in @nestjs/devtools-integration lets attackers run code on your machine via CSRF, leading to full Remote Code Execution (RCE).
Product
Customize license detection with Socket’s new license overlays: gain control, reduce noise, and handle edge cases with precision.
Product
Socket now supports Rust and Cargo, offering package search for all users and experimental SBOM generation for enterprise projects.