https://github.com/deftio/quikdown
Fast, secure markdown parser with bidirectional HTML conversion, plugin system, and live editor. Zero dependencies, XSS-safe by default. 9KB core.
https://github.com/deftio/quikdown
bidirectional html-to-markdown markdown markdown-converter markdown-editor markdown-html markdown-parser markdown-previewer markdown-to-html markdown-to-html-converter markdown-viewer no-dependencies zero-dependencies zero-dependency
Last synced: 22 days ago
JSON representation
Fast, secure markdown parser with bidirectional HTML conversion, plugin system, and live editor. Zero dependencies, XSS-safe by default. 9KB core.
- Host: GitHub
- URL: https://github.com/deftio/quikdown
- Owner: deftio
- License: bsd-2-clause
- Created: 2025-08-15T16:40:13.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-09-14T07:16:15.000Z (25 days ago)
- Last Synced: 2025-09-16T14:15:21.093Z (23 days ago)
- Topics: bidirectional, html-to-markdown, markdown, markdown-converter, markdown-editor, markdown-html, markdown-parser, markdown-previewer, markdown-to-html, markdown-to-html-converter, markdown-viewer, no-dependencies, zero-dependencies, zero-dependency
- Language: JavaScript
- Homepage: https://deftio.github.io/quikdown/examples/quikdown-live.html
- Size: 4.1 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: docs/security.md
Awesome Lists containing this project
README
# quikdown
[](https://github.com/deftio/quikdown/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/quikdown)
[](https://github.com/deftio/quikdown)
[](https://opensource.org/licenses/BSD-2-Clause)
Quikdown is a small, secure markdown parser with bidirectional conversion. Zero dependencies, XSS protection built-in, extensible via plugins for code highlighting and diagrams, and works in browser and Node.js.
For small and fast projects quikdown includes built-in inline styles for a "batteries included" rendering experience, but these can be overridden with themed css (see light and dark examples).
- **quikdown.js** (9.0KB) - Markdown to HTML Parser with theme support, XSS protection, fence callbacks
- **quikdown_bd.js** (13.8KB) - Bidirectional (HTML ↔ Markdown) Parser
- **quikdown_edit.js** (68.0KB) - Drop-in editor component with live preview, copy-as-rich-text, and lazy-loaded fence handlers
🚀 **[Live Demo](https://deftio.github.io/quikdown/examples/quikdown-live.html)** | **[Editor Demo](https://deftio.github.io/quikdown/examples/qde/)** | **[Documentation](docs/)**
📍 **Quick Links:** [Installation](#installation) • [Quick Start](#quick-start) • [API](#api-reference) • [TypeScript](#typescript-support) • [Plugins](#fence-plugins) • [Examples](examples/)
## Features
- 📦 **Zero dependencies** - No external libraries required
- 🌐 **Universal** - Works in browsers and Node.js
- 🚀 **Lightweight** - 9.0KB (core), 13.8KB (bidirectional), 68.0KB (editor)
- 🔒 **Secure by default** - Built-in XSS protection with URL sanitization
- 🎨 **Flexible styling** - Inline styles or CSS classes with theme support
- 🔌 **Plugin system** - Extensible fence block handlers
- ⚡ **Fast** - Optimized regex-based parsing
- 📝 **CommonMark subset** - Essential markdown features
- ✅ **Task Lists** - GitHub-style checkboxes
- 🔗 **Autolinks** - Automatic URL detection
- 🔄 **Bidirectional** - Convert HTML back to Markdown (quikdown_bd)
- 💬 **Lazy linefeeds** - Single newlines become line breaks (configurable)
- 📱 **Editor component** - Drop-in markdown editor with live preview
## Installation
Quikdown is available via [NPM](https://www.npmjs.com/package/quikdown) and related [unpkg](https://unpkg.com/quikdown) and [jsdelivr](https://cdn.jsdelivr.net/npm/quikdown)
### NPM package
```bash
npm install quikdown
```
### CDN using UNPKG
**CDN (ES Modules):**
```html
import quikdown from 'https://unpkg.com/quikdown/dist/quikdown.esm.min.js';
document.body.innerHTML = quikdown('# Hello World');
```
**CDN (UMD):**
```html
document.body.innerHTML = quikdown('# Hello World');
```
## Quick Start
Quikdown is built in 3 versions. The smallest (quikdown) provides markdown to html conversion only. The next (quikdown_bd) provides markdown to html and html to markdown support. The lightweight editor quikdown_edit allows a bidirectional editor with lazy loading for common fences such as codeblocks, svg, and mermaid diagrams is also provided.
### Markdown → HTML (quikdown.js)
```javascript
// Basic conversion
const html = quikdown('# Hello World',
{inline_styles: true} // Use inline styles, more options in API docs
);
document.body.innerHTML = html;
```
### Bidirectional Markdown ↔ HTML (quikdown_bd.js)
```javascript
// Convert with source tracking
const htmlString = quikdown_bd(markdown, options);
// Convert HTML back to Markdown
const markdown = quikdown_bd.toMarkdown(htmlString);
```
Note: quikdown does not provide a *generic* html to markdown conversion but uses special tags and limited DOM parsing for HTML to markdown conversion. Standard markdown components such as headings, text styles, tables, quotes, etc are supported. For custom fences quikdown relies on its tag system or 3rd party handlers to provide reverse (html to md) conversion.
### Editor (quikdown_edit.js)
```javascript
const editor = new QuikdownEditor('#container', {
mode: 'split', // 'source', 'split', 'preview'
theme: 'auto', // 'light', 'dark', 'auto'
plugins: { highlightjs: true, mermaid: true } // built-in fence handlers, see API docs for custom plugins
});
editor.setMarkdown('# Content \nTo be quik or not to be.'); // provide default content
const content = editor.getMarkdown(); // get source content, see APIs for getting / setting HTML
```
**Note:** The editor automatically lazy-loads plugin libraries from CDNs when needed:
- **highlight.js** - Loaded when code blocks are encountered and `highlightjs: true`
- **mermaid** - Loaded when mermaid diagrams are found and `mermaid: true`
- **DOMPurify** - Loaded when HTML fence blocks are rendered
- **KaTeX** - Loaded when math/tex fence blocks are encountered
This keeps the initial bundle small while providing rich functionality on-demand.
## Other Configuration Options
quikdown supports built-in styles for a "batteries included" experience or you can bring your own CSS themes. Example css files are provided for basic light and dark themes to get started.
```javascript
const html = quikdown(markdown, {
lazy_linefeeds: true, // Single newlines become
inline_styles: false, // Use class based CSS instead of inline styles
fence_plugin: { // Custom code block processor (v1.1.0+ API)
render: myHandler // Function to render fence blocks
}
});
```
### Styling Options
**Inline styles:** All formatting uses inline CSS
```javascript
quikdown('**bold**', { inline_styles: true });
// bold
```
**Class-based styling:** Uses CSS classes (default)
```javascript
quikdown('**bold**');
// bold
// Requires CSS: .quikdown strong { font-weight: bold; }
// see included dist/quikdown.light.css or quikdown.dark.css
```
### Fence Plugins
Quikdown provides a callback for all fenced text such as code blocks, math, svg etc.
Handle code blocks with custom languages:
```javascript
const fencePlugin = {
render: (code, language) => {
if (language === 'mermaid') {
// Process with mermaid library and return rendered diagram
const id = 'mermaid-' + Math.random().toString(36).substr(2, 9);
setTimeout(() => mermaid.render(id + '-svg', code).then(result => {
document.getElementById(id).innerHTML = result.svg;
}), 0);
return `
Loading diagram...`;
}
// Return undefined for default handling
}
};
const html = quikdown(markdown, { fence_plugin: fencePlugin });
```
## TypeScript Support
quikdown includes TypeScript definitions for better IDE support and type safety:
```typescript
import quikdown, { QuikdownOptions, FencePlugin } from 'quikdown';
const fencePlugin: FencePlugin = {
render: (content: string, language: string) => {
return `
${content}`;
}
};
const options: QuikdownOptions = {
inline_styles: true,
fence_plugin: fencePlugin
};
const html: string = quikdown(markdown, options);
```
## Supported Markdown
**Text formatting:** `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``
**Headings:** `# H1` through `###### H6`
**Lists:**
- Unordered lists
1. Ordered lists
- [x] Task lists
**Links:** `[text](url)` and automatic URL detection
**Code blocks:**
```javascript
console.log('syntax highlighting support via plugins');
```
**Tables, blockquotes, horizontal rules** - See [documentation](docs/) for complete syntax reference
## API Reference
For complete API documentation, see [docs/api-reference.md](docs/api-reference.md)
## Security
All HTML is escaped by default. Only safe markdown constructs become HTML:
```javascript
const unsafe = 'alert("XSS") **bold**';
const safe = quikdown(unsafe);
// <script>alert("XSS")</script> bold
```
## Framework Integration
Works with React, Vue, Svelte, Angular. See [Framework Integration Guide](docs/framework-integration.md) for examples.
## Limitations
For size and security, quikdown doesn't support:
- Reference-style links
- Footnotes
- Definition lists
Note that raw html, svg, etc can be rendered using appropriate fences
```html
My HTML Content
Some HTML
```
as long as an appropriate fence plugin is provided. See API docs for example or try out in quikdown_edit.js which has built-in support for HTML with XSS prevention.
## License
BSD 2-Clause - see [LICENSE.txt](LICENSE.txt)
## Acknowledgments
- Inspired by the simplicity of early markdown parsers
- Built for the [QuikChat](https://github.com/deftio/quikchat) project
- CommonMark spec for markdown standardization
## Support
- 📖 [Documentation](docs/)
- 🐛 [Issues](https://github.com/deftio/quikdown/issues)
- 📦 [Examples](examples/)