document0
1 min read

Installation

Zero UI. document0 is a headless documentation engine: it handles content sourcing, MDX processing, search, and navigation but ships with no UI components. You bring your own design system and have complete control over every pixel.

Requirements

  • Node.js 18 or later
  • React 18+ (for React/Next.js) or Vue 3+ (for Vue)

Install the packages

React / Next.js

npm install @document0/core @document0/mdx

You'll also need these peer dependencies:

npm install shiki @mdx-js/mdx react react-dom
PackagePurpose
shikiSyntax highlighting for code blocks
@mdx-js/mdxCompiling MDX at runtime
react / react-domRendering compiled MDX

Vue / Svelte / Other frameworks

npm install @document0/core @document0/mdc shiki

@document0/mdc processes markdown to HTML or JSON AST — no React dependencies needed. See the Vue guide or @document0/mdc reference.

CLI (optional)

Install the CLI to add plugins and components from the registry:

npm install -D @document0/cli

Then install components:

npx document0 add document0/sidebar document0/search-dialog

See the CLI reference for all commands.

Framework setup

document0 works with any Node.js framework. The Quickstart guide walks through a complete Next.js setup.

For React frameworks, use DocsSource and processMdx directly. For Vue and other frameworks, use DocsSource with processMdcToHtml from @document0/mdc.