feat: make doc-kit friendly for newcomers

.c8rc.json

@@ -3,8 +3,8 @@
   "exclude": [
     "eslint.config.mjs",
     "**/fixtures",
-    "packages/core/src/generators/legacy-html/assets",
-    "packages/core/src/generators/web/ui",
+    "packages/legacy/src/legacy-html/assets",
+    "packages/react/src/html/ui",
     "**/*.d.ts"
   ]
 }

.changeset/bootstrap-command.md

@@ -0,0 +1,11 @@
+---
+'@nodejs/doc-kit': minor
+---
+
+Add `doc-kit bootstrap [generators...]`: sets a project up end to end — a
+`doc-kit.config.mjs` whose naming and versioning are imported straight from
+`package.json`, a documentation directory (detected, or created with a
+starter page), a `.gitignore` entry for the output, and the generator
+packages installed. `doc-kit bootstrap` followed by `doc-kit serve` is all a
+new project needs. Prompts for its few decisions on a TTY; `--yes` accepts
+the defaults.

.changeset/configurable-navigation.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Add `web.navigation`, which supplies the sidebar groups (`navigation.sidebar`)

.changeset/curvy-items-smile.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': minor
+'@nodejs/doc-kit': minor
 ---
 
 Discover and load configuration files with `cosmiconfig`.

.changeset/did-you-know-that-the-world-is-round.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Close Orama search when the target link is on the same page

.changeset/display-name-type-unions.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Resolve unions and arrays of display-name types (`{HTTP/2 Headers Object | vm.Module}`, `{HTTP/2 Headers Object[]}`), and stop capturing prose such as `U+007B ({), and U+007D (}).` as a type annotation.

.changeset/doc-kit-scope-move.md

@@ -0,0 +1,8 @@
+---
+'@nodejs/doc-kit': major
+---
+
+The doc-kit engine and CLI, previously published as `@node-core/doc-kit`,
+are now published as `@nodejs/doc-kit`. The `@node-core/doc-kit` name now
+contains only the Node.js-specific generators (`api-links`, `addon-verify`,
+and `man-page`).

.changeset/fix-relative-parent-path.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Fix `relative()` URL resolution when the target path is a prefix of the current

.changeset/install-command.md

@@ -0,0 +1,10 @@
+---
+'@nodejs/doc-kit': minor
+---
+
+Add `doc-kit install [generators...]`: installs the packages providing the
+given built-in generators (e.g. `doc-kit install html` installs
+`@nodejs/doc-kit-generator-react`). Without arguments, it installs whatever
+the `target` in your configuration file needs. The package manager is
+detected from the project lockfile, and packages land in `devDependencies`
+unless the project depends on doc-kit in production.

.changeset/legacy-kitten-package.md

@@ -0,0 +1,11 @@
+---
+'@nodejs/doc-kit-generator-legacy': major
+'@nodejs/doc-kit': major
+---
+
+The legacy-format generators (`legacy-html`, `legacy-html-all`,
+`legacy-json`, and `legacy-json-all`) now live in the new
+`@nodejs/doc-kit-generator-legacy` package and are loaded via import specifiers such
+as `@nodejs/doc-kit-generator-legacy/legacy-html`. The corresponding
+`@nodejs/doc-kit/*` package exports have been removed. The CLI shorthand
+names are unchanged.

.changeset/monorepo-layout.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Moved the package into a `packages/core` workspace.

.changeset/node-kitten-package.md

@@ -0,0 +1,10 @@
+---
+'@node-core/doc-kit': major
+'@nodejs/doc-kit': major
+---
+
+The Node.js-specific generators (`api-links`, `addon-verify`, and
+`man-page`) now live in the `@node-core/doc-kit` package and are loaded
+via import specifiers such as `@node-core/doc-kit/man-page`. The
+corresponding package exports have been removed from the doc-kit engine.
+The CLI shorthand names are unchanged.

.changeset/node-preset.md

@@ -0,0 +1,5 @@
+---
+'@node-core/doc-kit': minor
+---
+
+Add the `@node-core/doc-kit/config` preset

.changeset/opt-out-banners.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': minor
+'@nodejs/doc-kit': minor
 ---
 
 Add banner opt-out

.changeset/plain-defaults.md

@@ -0,0 +1,6 @@
+---
+'@nodejs/doc-kit': patch
+'@nodejs/doc-kit-generator-react': minor
+---
+
+Defaults are now project-neutral instead of Node.js-specific

.changeset/react-kitten-package.md

@@ -0,0 +1,12 @@
+---
+'@nodejs/doc-kit-generator-react': minor
+'@nodejs/doc-kit': major
+---
+
+The React/JSX-based generators (`html` — previously `web` —, `jsx-ast`,
+`llms-txt`, `sitemap`, and `orama-db`) now live in the new
+`@nodejs/doc-kit-generator-react` package and are loaded via import specifiers such as
+`@nodejs/doc-kit-generator-react/html`. The corresponding `@nodejs/doc-kit/*`
+package exports have been removed. The `web` generator is renamed to `html`:
+the CLI shorthand `web` keeps working as a deprecated alias, but the
+configuration key is now `html` instead of `web`.

.changeset/riscv64-warning-spacing.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Fix missing spaces in the riscv64 multithreading warning message, which

.changeset/serve-command.md

@@ -0,0 +1,8 @@
+---
+'@nodejs/doc-kit': minor
+---
+
+Add `doc-kit serve`: generates the documentation, serves the output locally
+(port 3000 by default, falling back to the next available port or honoring
+`--port`), and regenerates whenever the input files change. `--static` serves
+an existing output directory as-is, without generating or watching.

.changeset/short-deprecation-links.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Use short `DEP` codes for deprecation heading anchors.

.changeset/spaced-union-types.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Space union separators in type annotation values (`{string|URL}` is now rendered as `string | URL`).

.changeset/specifier-generator-loading.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': minor
+'@nodejs/doc-kit': minor
 ---
 
 Generators are now loaded dynamically by import specifier instead of a static

.changeset/swc.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Switches `oxc-parser` for `@swc/wasm`, since `oxc-parser` does not provide the needed bindings.

.changeset/tidy-deprecations-smile.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Preserve deprecation codes in generated table-of-contents labels.

.changeset/tidy-donuts-search.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Sync the URL hash when following same-page search hits

.changeset/vite-web-generator.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': minor
+'@nodejs/doc-kit': minor
 ---
 
 Make the `web` generator bundler-neutral through a custom adapter contract,

.changeset/yes-i-did-know-that-thank-you.md

@@ -1,5 +1,5 @@
 ---
-'@node-core/doc-kit': patch
+'@nodejs/doc-kit': patch
 ---
 
 Render markdown `code` snippets in the sidebar

.github/workflows/ci.yml

@@ -141,7 +141,7 @@ jobs:
           path: node
 
       - name: Build docs
-        run: npx doc-kit generate -t web -i "./node/doc/api/assert.md" -o out
+        run: npx doc-kit generate -t web -i "./node/doc/api/assert.md" -o out --config-file ./e2e/doc-kit.config.mjs
 
       - name: Install Playwright browsers
         run: npx playwright install --with-deps

.github/workflows/publish.yml

@@ -56,9 +56,9 @@ jobs:
         env:
           SLACK_COLOR: '#43853D'
           SLACK_ICON: https://github.com/nodejs.png?size=48
-          SLACK_TITLE: ':rocket: Package Published: @node-core/doc-kit'
+          SLACK_TITLE: ':rocket: doc-kit Packages Published'
           SLACK_MESSAGE: |
-            :package: *Package*: `@node-core/doc-kit` (<https://www.npmjs.com/package/@node-core/doc-kit|View on npm>)
+            :package: *Packages*: `nodejs/doc-kit` workspace (<https://www.npmjs.com/package/@nodejs/doc-kit|@nodejs/doc-kit on npm>)
             :bust_in_silhouette: *Published by*: ${{ github.triggering_actor }}
             :octocat: *Commit*: <https://github.com/${{ github.repository }}/commit/${{ github.sha }}|${{ github.sha }}>
           SLACK_USERNAME: nodejs-bot

.gitignore

@@ -18,7 +18,7 @@ junit.xml
 isolate-*
 
 # Node's Source Folder
-node
+/node
 
 # Playwright
 playwright-report/

.prettierignore

@@ -1,11 +1,11 @@
 npm-shrinkwrap.json
 
 # Tests files
-packages/core/src/generators/api-links/__tests__/fixtures/
+packages/node/src/api-links/__tests__/fixtures/
 *.snapshot
 
 # Templates
-packages/core/src/generators/web/template.html
+packages/react/src/html/template.html
 
 # Output
 out/

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# `@node-core/doc-kit` Contributing Guide
+# `@nodejs/doc-kit` Contributing Guide
 
-Thank you for your interest in contributing to the `@node-core/doc-kit` project! We welcome contributions from everyone, and we appreciate your help in making this project better.
+Thank you for your interest in contributing to the `@nodejs/doc-kit` project! We welcome contributions from everyone, and we appreciate your help in making this project better.
 
 ## Table of Contents
 
@@ -29,7 +29,7 @@ Thank you for your interest in contributing to the `@node-core/doc-kit` project!
 
 ## Getting Started
 
-The steps below will give you a general idea of how to prepare your local environment for the `@node-core/doc-kit` project and general steps for getting things done and landing your contribution.
+The steps below will give you a general idea of how to prepare your local environment for the `@nodejs/doc-kit` project and general steps for getting things done and landing your contribution.
 
 ### Prerequisites
 
@@ -77,7 +77,10 @@ This repository is an npm workspaces monorepo. The root package is private and
 holds the shared tooling (linting, formatting, tests, changesets); every
 published package lives under `packages/`:
 
-- `packages/core`: [`@node-core/doc-kit`](packages/core)
+- `packages/core`: [`@nodejs/doc-kit`](packages/core) — the doc-kit engine and CLI
+- `packages/legacy`: [`@nodejs/doc-kit-generator-legacy`](packages/legacy) — the legacy-format generators
+- `packages/node`: [`@node-core/doc-kit`](packages/node) — the Node.js-specific generators
+- `packages/react`: [`@nodejs/doc-kit-generator-react`](packages/react) — the React/JSX-based generators
 
 Everything else at the root supports the repo rather than shipping to npm:
 `docs/` (the reference docs), `www/` (the documentation site), `scripts/` (build
@@ -357,7 +360,7 @@ version in `package.json`, and writes the corresponding `CHANGELOG.md` entries.
 
 To ship a release, a maintainer merges that "Version Packages" PR. The same workflow then:
 
-- publishes `@node-core/doc-kit` to npm (via [npm trusted publishing][] — no token required),
+- publishes the workspace packages to npm (via [npm trusted publishing][] — no token required),
 - creates the matching `v<x.y.z>` git tag, and
 - cuts a GitHub Release from the changelog.