{"$schema":"https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json","id":"packages-node-legacy","path":"/packages/node-legacy","type":"module","module":"packages-node-legacy","title":"`@node-core/doc-kit-legacy`","introducedIn":null,"sourceLink":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The generators for Node.js's legacy documentation formats: the classic HTML\npages and JSON files of the Node.js API docs, as Node.js's original\n[documentation tooling](https://github.com/nodejs/node/tree/main/tools/doc)\nwrote them, with the same templates, anchors and file names. They exist for\nNode.js and the tools that read those files.\n\nOther projects don't need them: build a site with the\n[website](https://doc-kit.nodejs.org/generators/html) generator, and API data\nwith [JSON](https://doc-kit.nodejs.org/generators/json).","summary":"The generators for Node.js's legacy documentation formats: the classic HTML pages and JSON files of the Node.js API docs, as Node.js's original documentation tooling wrote them, with the same templates, anchors and file names. They exist for Node.js and the tools that read those files.","examples":[],"children":[{"kind":"section","id":"install","name":"Install","title":"Install","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"```sh\nnpm install --save-dev @doc-kit/cli @node-core/doc-kit-legacy\n```","summary":"","examples":[{"language":"sh","displayName":null,"code":"npm install --save-dev @doc-kit/cli @node-core/doc-kit-legacy"}],"children":[]},{"kind":"section","id":"generators","name":"Generators","title":"Generators","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The CLI loads each target name from this package: `legacy-html` loads\n`@node-core/doc-kit-legacy/legacy-html`.\n\n| Target                                                                     | Output                                                                      |\n| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- |\n| [`legacy-html`](https://doc-kit.nodejs.org/generators/legacy-html)         | A classic HTML page per source file, such as `fs.html`, and its `assets/`   |\n| [`legacy-html-all`](https://doc-kit.nodejs.org/generators/legacy-html-all) | `all.html`, every page one after another                                    |\n| [`legacy-json`](https://doc-kit.nodejs.org/generators/legacy-json)         | A classic JSON file per source file, such as `fs.json`, with HTML in `desc` |\n| [`legacy-json-all`](https://doc-kit.nodejs.org/generators/legacy-json-all) | `all.json`, the sections of every JSON file merged                          |\n\n`legacy-html-all` and `legacy-json-all` run `legacy-html` and `legacy-json`\nfirst.","summary":"The CLI loads each target name from this package: `legacy-html` loads `@node-core/doc-kit-legacy/legacy-html`.","examples":[],"children":[]},{"kind":"section","id":"usage","name":"Usage","title":"Usage","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"```sh\nnpx @doc-kit/cli generate -t legacy-html -t legacy-json -i \"doc/api/*.md\" -o out\n```\n\n> \\[!IMPORTANT]\n> The HTML pages build their source and edit links from `repository`, and the\n> version picker's links from `baseURL`, which have no flags. Set them under\n> `global` in your configuration file (`nodejs/node` and\n> `https://nodejs.org/docs`), or extend the\n> [Node.js preset](https://doc-kit.nodejs.org/packages/node), which sets both,\n> along with `changelog`.","summary":"","examples":[{"language":"sh","displayName":null,"code":"npx @doc-kit/cli generate -t legacy-html -t legacy-json -i \"doc/api/*.md\" -o out"}],"children":[]}]}