@doc-kit/core

The core of doc-kit: the engine that turns API-shaped Markdown into documentation sites, JSON, man pages, and more. It powers the Node.js API reference, and it can document any project.

The command-line interface lives in the companion @doc-kit/cli package.

Output formats are provided by generators. This package ships the shared pipeline stages and json-simple; the rest come from companion packages:

Custom generators load by import specifier — any module whose default export is a generator works as a --target.

This package lives in the nodejs/doc-kit monorepo. From this directory (or the repository root with npm run <script> --workspace @doc-kit/core):

# Run this package's tests
npm test

# Re-run the tests on every change
npm run test:watch