Minimal, copy-pasteable examples organized to mirror the docs: Editor, Document Engine, AI.
Examples teach one concept in the smallest useful amount of code. If you want a composed app or product workflow, see demos/ instead.
The machine-readable index lives in manifest.json.
Framework starters. Pick one, run pnpm install && pnpm dev.
| Example | Description |
|---|---|
| react | React + TypeScript with Vite |
| vue | Vue 3 + TypeScript with Vite |
| vanilla | Plain JavaScript with Vite |
| cdn | Zero build tools, just an HTML file |
| angular | Angular setup |
| nextjs | Next.js (SSR-safe) |
| nuxt | Nuxt setup |
| laravel | Laravel + Inertia |
Patterns for the browser editor surface.
| Example | Docs |
|---|---|
| comments | docs |
| track-changes | docs |
| toolbar | docs |
| Example | Docs |
|---|---|
| selection-capture | docs |
| configurable-toolbar | docs |
| Example | Docs |
|---|---|
| theming | docs |
| Example | Docs |
|---|---|
| spell-check | docs |
Realtime providers and backend setups for Yjs-based collaboration.
| Example | Description |
|---|---|
| providers/superdoc-yjs | Self-hosted Yjs server (recommended) |
| providers/hocuspocus | Hocuspocus provider setup |
| providers/liveblocks | Liveblocks managed service |
| backends/node-sdk | Server-side document operations alongside the realtime layer |
| backends/fastapi | Python FastAPI backend |
Programmatic editing without a visible editor.
| Example | Docs |
|---|---|
| diffing | docs |
| ai-redlining | docs |
Document editing through models and agents.
| Example | Description |
|---|---|
| bedrock | AWS Bedrock Converse API with tool use |
| streaming | Stream model output into a visible editor |
| redlining | LLM-driven tracked-change review (browser) |
Edge cases and infrastructure-level patterns. Most consumers won't need these.
| Example | Notes |
|---|---|
| extensions/custom-mark | Custom mark authoring |
| extensions/custom-node | Custom node authoring |
| headless-toolbar | Framework-agnostic toolbar substrate |
cd <path-to-example>
pnpm install
pnpm devFor the CDN example, open index.html directly or run npx serve ..