Types


Nivel exports public TypeScript types for docs config, graph nodes, resolved runtime data, and page metadata. Consumers should use these types with satisfies on plain objects.

JavaScript
export {}

Common types

  • DocsConfig describes pages/+docs.ts.
  • DocsGraph describes the top-level graph.
  • DocsSectionNode, DocsGroupNode, and DocsPageNode describe graph items.
  • ResolvedDocsConfig describes the normalized runtime model.
  • ResolvedDocsPage describes resolved page data.
  • DocHeading describes extracted MDX headings.

For concrete graph examples, read The Docs Graph and Sections, Groups and Pages.