Everything you need to ship with quikdown.
Parser API, bidirectional model, editor component, fence plugin guide, framework integration, security model, TypeScript types — all in one place.
Start here
✏️ Try the editor
Free, in-browser markdown editor. The same component you can drop into your app.
🎓 Examples hub
Interactive ladder: parser, editor, LLM streaming, agent tools, offline standalone.
🤖 LLM integration
Stream into the editor, agent tool calling, quikchat pairing — patterns for agent UIs.
🔌 MCP Server
AI agent integration — 24 tools for Cursor, Claude Desktop, VS Code via Model Context Protocol. Path A (bin) and Path B (doc host + browser).
📖 README
Project overview, installation, quick start, and the core API surface.
Reference
API Reference
Complete public API for all modules — parser, bidirectional, editor, AST, JSON, YAML, MCP.
Editor Guide
QuikdownEditor options, methods, events, and headless mode.
Standalone / offline editor
Air-gapped bundle (~7.7 MB / ~1.0 MB gzipped): all fence libs built in, release zip, no CDN.
Bidirectional Guide
How data-qd-* attributes enable HTML → Markdown round-tripping.
Fence Plugin Guide
Write a fence plugin with render and reverse handlers for custom code-fence types.
AST Guide
The optional AST module for working with markdown as a structured tree (JSON, YAML, AST→HTML).
MCP Server Guide
Complete tool reference, JSON-RPC protocol, setup for Cursor, Claude Desktop, VS Code, and programmatic usage.
Framework Integration
React, Vue, Svelte, Angular — patterns for embedding quikdown in any framework.
Release process
Shipping, standalone bundle gates, verify:release, air-gap zip on GitHub Release.
Security Model
XSS protection, URL sanitization, what's safe by default, and what to watch for in fence plugins.
Architecture
Parser internals, lexer design, fence handling pipeline. For contributors and curious users.
Lexer Implementation
Deep dive into the parser's lexer state machine.