quikdown

Quikdown is an efficient and secure Markdown parser designed for both browser and Node.js applications. It features a comprehensive editor that allows users to convert Markdown to HTML and vice versa, rendering rich fenced-block content while ensuring a smooth editing experience. With a minimal core size of approximately 15-17 KB and no runtime dependencies, Quikdown is particularly well-suited for environments where safety and size are paramount.

Key Features

• Compact Editor: The Quikdown editor offers a straightforward implementation through a single <div> and supports multiple modes: source, split, and preview. Users can utilize a toolbar, customize themes, and benefit from features like undo/redo and copy-as-rich-text capabilities.
• Bidirectional Markdown Parsing: Quikdown facilitates ease of conversion between Markdown and HTML, allowing edits to the rendered output while ensuring that changes can be accurately reflected back in Markdown format.
• Rich Content Support: It includes built-in renderers for various formats, such as:
  • Syntax-highlighted code
  • Mermaid diagrams
  • MathJax equations for mathematical content
  • Tables from CSV/TSV/PSV formats
  • GeoJSON maps and STL models
  • Customizable and sanitized HTML content
• Safety Features: The parser escapes HTML by default, blocks unsafe URL schemes, and utilizes DOMPurify for raw HTML rendering, assuring users against common XSS vulnerabilities.
• Offline Capabilities: Quikdown offers a standalone build that does not require a network connection, making it ideal for regulated environments and offline applications.
• Support for Collaboration: Designed with collaborative workflows in mind, Quikdown allows AI agents and human editors to work on the same Markdown document, leveraging its headless API for seamless integration.
• Modular Design: Developers can utilize only the components needed for their projects, with options ranging from the core parser to full editor functionalities, enabling flexibility in application architecture.

Getting Started

Quikdown can be easily integrated into projects. It supports common front-end frameworks like React, Vue, Svelte, and Angular, or can be utilized directly in plain browser applications. The API is designed to be developer-friendly, allowing quick implementation and customization.

Example Usage

import quikdown from 'quikdown';

const markdown = '# Hello World\n\nThis is **Markdown**.';
const html = quikdown(markdown);

document.body.innerHTML = html;

With Quikdown, developers can enhance applications that require Markdown functionality, ensuring a balance between performance, security, and usability.