Find a guide
Choose a task below, or start with installation if this is your first visit. Framework-specific guides are marked React, Vue or Mantine; shared parsing guides apply to all three.
Choose your adapter
Section titled “Choose your adapter”| Application | First render | Next task | Reference |
|---|---|---|---|
| React | React quick start | Streaming chat, custom components | React components |
| Vue | Vue quick start | Streaming, custom rendering | Vue API |
| React with Mantine | Mantine quick start | Code blocks and diagrams | Mantine API |
| Framework adapter author | Build a framework adapter | Core and engine contracts | Core, Engine |
Once the first render works, Configure rendering explains which layer to change: parsing options shared by React and Vue, or the component and styling APIs that differ per adapter.
Streaming
Section titled “Streaming”| Task | Guide | Applies to |
|---|---|---|
| Understand accumulated input, completion and cancellation | Streaming input | All |
| Build a chat view that renders tokens as they arrive | React streaming chat | React |
| Smooth out bursty token delivery | React smooth streaming | React |
| Show a cursor at the streaming edge | React streaming cursor | React |
| Stream into a Vue component | Vue streaming | Vue |
| Split a logical document into sections that share references | Documents and references | All |
| Coordinate footnotes and links across React chunks | React documents and references | React |
| Coordinate footnotes and links across Vue chunks | Vue documents and references | Vue |
Content and styling
Section titled “Content and styling”| Task | Guide | Applies to |
|---|---|---|
| Add code, Mermaid, image preview and table export | Rich Markdown components | React, Vue, Mantine |
| Choose which layer to configure | Configure rendering | All |
| Check which Markdown syntax renders | Markdown features | All |
| Render CJK and mixed-language text | CJK typography | All |
| Transform the source before parsing | Content preprocessors | All |
| Configure URL and HTML policies | URL sanitization | All |
| Replace rendered elements with your own components | React custom components | React |
| Swap the typography container | React custom typography | React |
| Theme spacing, colors and fonts with CSS variables | React CSS tokens | React |
| Customize rendering and styles in Vue | Vue custom rendering and styling | Vue |
| Try your own Markdown in the browser | Examples and playgrounds | All |
Integrations and performance
Section titled “Integrations and performance”| Task | Guide | Applies to |
|---|---|---|
| Render code blocks and diagrams with Mantine | Mantine code blocks and diagrams | Mantine |
| Server-render and hydrate | React SSR and hydration | React |
| Server-render and manage the component lifecycle | Vue SSR and lifecycle | Vue |
| Understand what incremental parsing saves | Rendering and performance | All |
| Keep re-renders cheap while streaming | React streaming and performance | React |
API reference
Section titled “API reference”| Need | Page |
|---|---|
| Every React prop with defaults | React props reference |
| Hooks and providers | React hooks and providers |
| Metadata passed to custom components | React metadata context |
| Generic component and prop types | React TypeScript generics |
| Vue props, slots and exports | Vue API |
| Mantine props and configuration | Mantine API |
| What stays stable under minor versions | API conventions and stability |
Troubleshooting and upgrades
Section titled “Troubleshooting and upgrades”| Task | Guide |
|---|---|
| Fix a symptom across adapters | Troubleshooting |
| Upgrade from the old package scope | Package migration |
| Upgrade a 1.x installation to 2.0 | Migrating from 1.x to 2.0 |
| See versioned changes | Release highlights |
| Decide what to pin or assert in tests | Stability policy |
The 1.x-to-2.x migration page and the July 2026 benchmark describe their named versions, not today’s installation requirements.
Build an integration
Section titled “Build an integration”| Task | Guide |
|---|---|
| Build a framework adapter | Build a framework adapter |
| Rely on the shared packages | Core and engine contracts |
| Ship a React design-system package | Build a React integration |
| Read the package APIs | Core, Engine, highlight plugin, code language detector |
Contributing
Section titled “Contributing”| Task | Guide |
|---|---|
| Run checks, tests and builds | Development commands |
| Learn which package owns which file | Architecture overview |
| Edit or deploy this site | Documentation site |
| Develop the Storybook examples | Interactive examples |
| Measure a change | Benchmarking |
| Validate core contracts and state sequences | Core testing |
| Decide whether a change needs a soak | Soak coverage map |
| Cut a release | Releasing |
| Keep a guide aligned with the implementation | Reading the implementation |
Release maintenance: published-artifact verification. The 3.0 release acceptance record is an archive of that release.
Moved sections
Section titled “Moved sections”The following sections used to live on this page. Their content is unchanged.
A note on stability is now the stability policy and the shared packages section.
Conventions used in this guide is now conventions used in the guides.
Reporting issues with these docs is now reporting issues with these docs.
Reading the implementation alongside the guides is now reading the implementation alongside the guides.