@docubook/docs-tree

Prebuild navigation tree for DocuBook documentation.

Installation

npm

npm install --save-dev @docubook/docs-tree

pnpm

pnpm add -D @docubook/docs-tree

yarn

yarn add -D @docubook/docs-tree

bun

bun add -d @docubook/docs-tree

Usage

npm

npx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json

pnpm

pnpm dlx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json

yarn

yarn dlx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json

bun

bunx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json

Or run with default paths:

npx @docubook/docs-tree  # Uses ./docs, ./docu.json, ./docs-tree.json

Implementation in DocuBook Projects

Add to your package.json scripts:

{
  "scripts": {
    "prebuild": "pnpm dlx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json",
    "build": "pnpm run prebuild && next build"
  }
}

Import in your routes file:

// lib/route.ts
import docsTree from "@/lib/docs-tree.json";

export const ROUTES = docsTree;

The navigation tree will be prebuilt before each production build, with intelligent caching to skip regeneration when no changes are detected.