dartdoc-vitepress

Appearance

dartdoc-vitepressModern API Docs for Dart

Drop-in replacement for dart doc — generates a VitePress site with search, dark mode, and full customization

Quick Start
API Reference
GitHub
API
Guide
{}
</>
///
.md
📚

Full API Reference

Every class, function, and type gets its own page with clickable type links and syntax-highlighted signatures.

🔍

Fast Offline Search

Built-in full-text search across all pages. Works offline, no external service required.

🌙

Dark Mode & Theming

Light/dark toggle out of the box. Customize with CSS or build Vue components — full VitePress ecosystem.

📖

Guide Pages

Put markdown files in doc/ or docs/ — they become guide pages with auto-generated sidebar navigation.

📦

Mono-repo Support

One command generates unified docs for all packages in a Dart workspace with --workspace-docs.

🎮

Interactive DartPad

Tag a code block with dartpad and it becomes a live, editable Dart playground inside your docs.

🔗

Auto-Linking

Write `ClassName` in your guides and it automatically links to the API page. No manual URLs.

⚡

Incremental Generation

Only rewrites changed pages. Re-runs are fast even for large packages.

Install ​

bash
dart pub global activate dartdoc_vitepress

Usage ​

bash
dartdoc_vitepress --format vitepress --output docs-site
cd docs-site && npm install && npx vitepress dev
bash
dartdoc_vitepress --format vitepress \
  --workspace-docs \
  --exclude-packages 'example,test_utils' \
  --output docs-site
bash
dartdoc_vitepress --sdk-docs --format vitepress --output docs-site

dart doc vs dartdoc-vitepress ​

dart docdartdoc-vitepress
OutputStatic HTMLVitePress (Markdown + Vue)
SearchBasicFull-text, offline
Dark modeNoYes
Guide docsNoAuto from doc/
Mono-repoNo--workspace-docs
DartPad embedsNoYes
Mermaid diagramsNoYes, with zoom
CustomizationTemplatesCSS, Vue components, plugins

Live Example ​

Dart SDK API docs — 56 libraries, 1800+ pages, generated with dartdoc-vitepress.