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
📖 README
Project overview, installation, quick start, and the core API surface.
🎓 Examples ladder
Sixteen working examples organized as a learning ladder. Start with hello-world, end with headless editor in your app.
✏️ Try the editor
Free, in-browser markdown editor. The same component you can drop into your app.
Reference
API Reference
Complete public API for all six modules — parser, bidirectional, editor, AST, JSON, YAML.
Editor Guide
QuikdownEditor options, methods, events, and headless mode.
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).
Framework Integration
React, Vue, Svelte, Angular — patterns for embedding quikdown in any framework.
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.