You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d225020
Browse filesBrowse the repository at this point in the historyBrowse files
chore: remove the legacy-json and legacy-json-all generators
This removes the rest of the legacy stack, and with it the
`@node-core/doc-kit-legacy` package and what only it used in
`@doc-kit/core`: `getRemarkRehype` and `rehypeOptions`. The docs site
builds its per-page JSON with the `json` generator instead.
Node.js's build still targets `legacy-json-all` for `doc/api/*.json`
and `all.json` (`tools/doc/web.doc-kit.config.mjs`), so this can only
land once Node.js moves to `json` and `json-all`.
Assisted-by: Claude Opus 5.5 <[email protected]>
Remove the `legacy-html`and `legacy-html-all` generators, now that Node.js builds its API docs with the redesigned `html`generator. The `@doc-kit/core` exports only they used are removed too: `shiki.config.mjs`, `utils/remark-shiki.mjs`, and the default export of `utils/highlighter.mjs`
6
+
Remove the legacy-format generators (`legacy-html`, `legacy-html-all`, `legacy-json`, and `legacy-json-all`) and the `@node-core/doc-kit-legacy` package, now that Node.js builds its API docs with the redesigned generators. Use `html`for pages, and `json` and `json-all` for JSON. The `@doc-kit/core` exports only they used are removed too: `shiki.config.mjs`, `utils/remark-shiki.mjs`, `getRemarkRehype` and `rehypeOptions` from `utils/remark.mjs`, and the default export of `utils/highlighter.mjs`
-p, --threads <number> Number of threads to use (minimum: 1)
@@ -89,18 +89,6 @@ Options:
89
89
90
90
## Examples
91
91
92
-
### Legacy
93
-
94
-
To generate a 1:1 match with the JSON of the [legacy tooling](https://github.com/nodejs/node/tree/main/tools/doc), use the `legacy-json` and `legacy-json-all` generators.
95
-
96
-
```sh
97
-
npx @doc-kit/cli generate \
98
-
-t legacy-json \
99
-
-i "path/to/node/doc/api/*.md" \
100
-
-o out \
101
-
--index path/to/node/doc/api/index.md
102
-
```
103
-
104
92
### Redesigned
105
93
106
94
To generate [our redesigned documentation pages](https://nodejs-api-docs-tooling.vercel.app), use the `html` and `orama-db` (for search) generators. These generators live in the separate [`@doc-kit/generator-react`](packages/react) package, which must be installed alongside this one.
|[`@doc-kit/generator-react`](https://www.npmjs.com/package/@doc-kit/generator-react)|`html` (the modern site), `orama-db`, `llms-txt`, `sitemap`|
|[`@doc-kit/generator-react`](https://www.npmjs.com/package/@doc-kit/generator-react)|`html` (the modern site), `orama-db`, `llms-txt`, `sitemap`|
0 commit comments