Packages
Deep reference for every @docvia/* package: what each one does, where it runs, and every export.
On this page
docvia ships as eight packages. Two hold almost everything, split by where the code runs; the rest are the command line, search and the plugins with heavy dependencies. This section is the API reference for each one. For task-oriented walkthroughs, see the Guides.
| Package | Runs | What it is |
|---|---|---|
@docvia/core | Anywhere: Workers, browsers, Node | Config and plugin API, the IR, Markdown parsing, rendering, sources, SSR, and the React and Svelte bindings. No Node APIs. |
@docvia/build | Node, at build time | The compiler, the page pipeline, config file loading, and the Vite and Next.js plugins. |
@docvia/cli | Node | The docvia command (init, build, dev, sync, preview). |
@docvia/search | Anywhere | Section-level Orama indexing and the client search helper. |
@docvia/markdown | Anywhere, any app | A dependency-free Markdown renderer with streaming for AI output. Needs nothing else from docvia. |
@docvia/plugin-shiki | Build time | Syntax highlighting via Shiki. |
@docvia/plugin-mermaid | Build time | Mermaid fences as diagram components. |
@docvia/plugin-openapi | Build time, plus a Workers-safe proxy | API reference pages from an OpenAPI spec. |
An app usually installs two of them:
pnpm add @docvia/core @docvia/search
pnpm add -D @docvia/build @docvia/plugin-shiki
@docvia/core
Each area is a subpath, so an app only bundles what it imports.
- Types and IR and the plugin API:
@docvia/core - Markdown:
@docvia/core/markdown - Frontmatter schema:
@docvia/core/schema - Rendering:
@docvia/core/render - Sources:
@docvia/core/source - SSR:
@docvia/core/ssr - React and Svelte:
@docvia/core/react,@docvia/core/svelte
@docvia/build
- Pipeline and compile service:
@docvia/build compile():@docvia/build- Vite plugin:
@docvia/build/vite - Next.js plugin:
@docvia/build/next