Nivel logoNivel

Getting Started

Nivel is a structure-first documentation engine for React apps built with Vike. You define the docs structure once, then Nivel resolves routes, aliases, navigation, page metadata, MDX runtime data, and layout context from that graph.

The consumer stays intentionally thin: content, docs.graph.ts, visible Vike shell files, brand assets, and theme files remain local. Nivel owns the generated route layer and the reusable docs runtime.

Installation

Install @unterberg/nivel with its Vike, React, Vite, and TypeScript peer dependencies.

Quick Start

Scaffold a consumer, generate Nivel pages, and run the standard Vike development workflow.

Project Shape

See which files remain consumer-owned and which files Nivel generates from the docs graph.

First Docs Page

Create an MDX page, register it in the docs graph, and generate the matching Vike route files.

What Nivel provides

  • typed DocsConfig and DocsGraph surfaces
  • generated Vike docs pages from one graph
  • navbar, sidebar, breadcrumbs, table of contents, pagination, and meta head wiring
  • MDX support with built-in docs components and code-block tooling
  • Tailwind v4 and daisyUI integration helpers
  • a small CLI for scaffolding and docs page generation

Good first path

Start with Installation, then follow Quick Start. After that, read The Docs Graph to understand why the graph is the center of the system.