Npm Factory

Getting Started

The docs preset is automatically included in sites generated by @npm-factory/init. No manual setup required.

Import and use createDocsNavFromDot to build your site's navigation:

import { createDocsNavFromDot } from "@npm-factory/docs-preset";
import { dot } from "@my-org/my-project-config";

const nav = createDocsNavFromDot(dot);

The nav tree respects docs.apiDocs — when set to "disabled", API and JSDoc entries are excluded.

On this page