Nivel logoNivel

Project Shape

A Nivel consumer should look like a normal Vike app with a small docs contract. The important part is that generated internals are isolated while the files a consumer is expected to understand stay visible.

Consumer-owned files

Keep these local and editable:

  • docs/docs.graph.ts or content/docs.graph.ts
  • pages/+docs.ts
  • pages/+config.ts
  • pages/+Head.tsx
  • pages/+Layout.tsx
  • pages/+onCreateGlobalContext.ts
  • pages/+Wrapper.tsx
  • global.d.ts
  • docs content, brand assets, and CSS/theme files

Engine-generated files

Only pages/(nivel-generated) is generated by Nivel. It may be deleted and regenerated at any time, so it should not contain consumer decisions.

The split is described in more detail in Consumer-owned vs Engine-owned. The graph that drives the generated output is covered in The Docs Graph.