Covendocs

Docs Platform

How Coven docs use Fumadocs components, search, exports, and validation.

Docs Platform

Coven docs use Fumadocs as the documentation substrate: MDX components for richer pages, built-in search, export paths, link validation, and optional Obsidian import tooling.

Author MDX

Use standard MDX plus the shared Fumadocs component registry. Code fences render through the Fumadocs code block wrapper, and images use zoom automatically.

Validate and build

Run the Fumadocs platform check, Mermaid checks, link validation, and the Next build before publishing docs changes.

Export when needed

EPUB is available from `/export/epub`. PDF export runs against a local server so rendered pages, diagrams, and styles are captured.

Tooling

route.ts
export-pdf.mjs
Export PDF
npm run export:pdf
Validate docs platform wiring
npm run check:fumadocs
npm run check:links
npm run build
Generate docs from a vault
OBSIDIAN_VAULT_DIR="../Coven Vault" npm run export:obsidian

Runtime Fields

Prop

Type

QA Checklist

Prop

Type

Last updated on

On this page