Skip to content
Packages

Packages

Deep reference for every @docvia/* package: contracts, parsing, orchestration, rendering, runtime, and integration.

docvia ships as a set of focused, single-purpose packages. This section is the deep API reference for each one: every export, signature, and option. For task-oriented walkthroughs, see the Guides.

Contracts

  • @docvia/ir is the Intermediate Representation, the shared error system, the compiler/renderer/plugin contracts, and the AST → IR transform.

Parsing

  • @docvia/core is the Markdown parsing pipeline (unified + remark + rehype).
  • @docvia/schema handles frontmatter validation (Zod), YAML extraction, and TypeScript codegen.

Compile core

  • @docvia/runtime holds CompileService, the stateful compile core shared by build, dev, and SSR.
  • @docvia/compiler is the batch build entry (compile()), content hashing, the incremental cache, and module-graph generation.
  • @docvia/plugins provides defineConfig, loadConfig, and the PluginRunner.

Rendering

Runtime

  • @docvia/source is the runtime collection model (createCollection / createSource) the generated source.ts is built on.
  • @docvia/ssr does request-time rendering for Node and edge runtimes.
  • @docvia/search provides section-level Orama indexing and the client search helper.

Integration