Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

@node-core/doc-kit-legacy

The Node.js legacy-format generators for doc-kit: 1:1 matches for the output of Node.js's original documentation tooling, for consumers that depend on the classic HTML and JSON layouts.

Install

npm install --save-dev @doc-kit/core @node-core/doc-kit-legacy

Generators

Target Output
legacy-html One classic HTML page per input document.
legacy-html-all The single-page all.html bundling every document together.
legacy-json The classic per-document JSON, as published on nodejs.org.
legacy-json-all The single-file JSON bundling every document together.

Usage

npx @doc-kit/cli generate -t legacy-html -t legacy-json -i "doc/api/*.md" -o out

Unless you have consumers of these exact formats, prefer the modern html generator from @doc-kit/generator-react. See the doc-kit documentation for details.