# QuireKit Markdown developer documentation

Shared Lezer Markdown core, incremental streaming and Vue/React rendering. Packages are @quirekit/incremark-core, @quirekit/incremark and @quirekit/incremark-react, currently workspace previews.

[简体中文](/llms.txt)

- [Documentation overview](/raw/en/index.md): One parser and renderer for static documents and streaming AI answers.
- [Quick start](/raw/en/guide/getting-started.md): Render your first Markdown in Vue and understand source, themes and persistence.
- [Playground](/raw/en/playground.md): Edit source and compare static loading with streaming updates of the same Markdown.
- [Syntax and support](/raw/en/guide/syntax.md): Understand defaults, explicit configuration and capabilities supplied by your application.
- [AI streaming](/raw/en/guide/streaming.md): Render arriving Markdown as one message and handle completion, cancellation and failure.
- [React integration](/raw/en/guide/react.md): React components, streaming, SSR and custom nodes sharing the Vue parser core.
- [Headless parsing](/raw/en/guide/headless.md): Parse Markdown into text and a syntax tree without creating a reading component.
- [UI and editor integration](/raw/en/guide/integration.md): Choose the independent reader or keep the editor product capabilities in MdProse.
- [Custom components](/raw/en/guide/components.md): Replace links, images or code-block presentation while retaining Markdown parsing.
- [Custom syntax and nodes](/raw/en/guide/extensions.md): Add parsing and reading support for application syntax, using task status markers.
- [Flowcharts, mind maps and whiteboards](/raw/en/guide/diagrams.md): Render native editor diagrams in documentation and integrate them into a Markdown reading component.
- [HTML and inline styles](/raw/en/guide/html.md): Render Markdown HTML and restrict its elements, destinations and inline styles.
- [Compared with Incremark](/raw/en/guide/comparison.md): Why we redesigned Incremark, and how the new engine handles streaming Markdown.
- [Incremental rendering and performance](/raw/en/guide/performance.md): Understand default caching, declare custom dependencies and measure update work.
- [Parsing API](/raw/en/api/core.md): Signatures and descriptions generated from the public TypeScript exports.
- [Vue and extension API](/raw/en/api/vue.md): Signatures and descriptions generated from the public TypeScript exports.
- [React API](/raw/en/api/react.md): Public React component, hook and extension types generated from source.