Skip to content

dartdoc_modernModern API Docs for Dart

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

API
Guide
{}
</>
///
.md

Install

bash
dart pub global activate dartdoc_modern

Usage

dart doc vs dartdoc_modern

dart docdartdoc_modern VitePressdartdoc_modern Jaspr
OutputStatic HTMLVitePress (Markdown + Vue)Jaspr app (Dart + SSR/static build)
SearchBasicFull-text, offlineFull-text, offline
Dark modeNoYesYes
Guide docsNoAuto from doc/Auto from doc/
Mono-repoNo--workspace-docs--workspace-docs
Build speed / file countMany HTML pagesMuch faster, far fewer filesMuch faster, far fewer files
DartPad embedsNoYesYes
Mermaid diagramsNoYes, with zoomYes, with runtime rendering
CustomizationTemplatesCSS, Vue components, pluginsDart components, theme tokens, CSS

Why It Builds Much Faster

dartdoc_modern is dramatically faster largely because it writes dramatically fewer files.

Standard dartdoc creates a separate HTML page for every member. Every method, property, constructor, and constant gets its own full HTML page with head, navigation, sidebar, and footer. dartdoc_modern keeps members inline on the library or type page instead.

  • The Flutter Icons class has about 2,000 static constants. dartdoc turns that into about 2,001 pages for one class. dartdoc_modern keeps it on one page.
  • For the full Dart SDK, dartdoc generates roughly 15,000+ HTML files. dartdoc_modern generates about 1,800 markdown files, around 52 MB of source markdown.
  • For icon packages like material_design_icons_flutter with 7,000+ static const icons, dartdoc would emit 7,000+ individual pages. dartdoc_modern keeps that as one page.

This is a deliberate architectural choice, not a limitation. It reduces file-system churn, cuts I/O, speeds up builds, and makes browsing APIs better: you can Ctrl+F through the whole class, jump with the outline, and use search without opening dozens of member pages.

Live Example

Dart SDK API docs generated with dartdoc_modern.

Live Versions