@document0/core

The core package for document0. Provides file system source loading, page tree building, navigation utilities, and search indexing, with zero UI assumptions.

Install

npm install @document0/core
# or
pnpm add @document0/core
# or
yarn add @document0/core
# or
bun add @document0/core

Usage

Load pages from the file system

import { DocsSource } from "@document0/core";

const source = new DocsSource({
  rootDir: "./content/docs",
  baseUrl: "/docs",
});

const pages = source.getPages();
const page = source.getPage("getting-started");

Build a page tree

import { DocsSource, buildPageTree } from "@document0/core";

const source = new DocsSource({ rootDir: "./content/docs" });
const tree = buildPageTree(source.getPages(), "./content/docs");

The tree respects _meta.json files in each directory for ordering and naming:

{
  "title": "Getting Started",
  "pages": ["introduction", "installation", "--- Usage", "quickstart"],
  "defaultOpen": true
}

Use "---" for an unnamed separator, or "--- Label" for a labelled separator.

Navigation utilities

import { getBreadcrumbs, getPageNeighbours, isActiveOrAncestor } from "@document0/core";

const breadcrumbs = getBreadcrumbs(tree, "/docs/guides/installation");
const { previous, next } = getPageNeighbours(tree, "/docs/guides/installation");
const active = isActiveOrAncestor(node, currentUrl);

Search

import { createSearchRoute } from "@document0/core";

// In your API route (e.g. app/internal/search/route.ts)
export const { GET } = createSearchRoute(source);

Types

export type TreeNode = PageNode | FolderNode | SeparatorNode;

interface PageNode {
  type: "page";
  name: string;
  url: string;
  slug: string;
  icon?: string;
}

interface FolderNode {
  type: "folder";
  name: string;
  defaultOpen?: boolean;
  index?: PageNode;
  children: TreeNode[];
  icon?: string;
}

interface SeparatorNode {
  type: "separator";
  name: string;
}

License

MIT