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
This is the Node.js API documentation generator (`@node-core/doc-kit`). It is a single-package Node.js CLI tool (no monorepo, no Docker, no external services).
6
+
7
+
### Runtime
8
+
9
+
- Requires **Node.js 24** (see `.nvmrc`). Use `nvm install 24 && nvm use 24` if not already active.
10
+
- Package manager is **npm** (lockfile: `package-lock.json`).
11
+
12
+
### Key commands
13
+
14
+
All standard dev commands are in `package.json``scripts` and documented in `CONTRIBUTING.md`:
15
+
16
+
| Task | Command |
17
+
|---|---|
18
+
| Install deps |`npm install`|
19
+
| Lint |`node --run lint`|
20
+
| Format check |`node --run format`|
21
+
| Tests |`node --run test`|
22
+
| Tests + coverage |`node --run test:coverage`|
23
+
| Run CLI |`node bin/cli.mjs`|
24
+
25
+
### Running the tool locally
26
+
27
+
To actually generate docs you need Node.js API markdown sources. Sparse-clone them:
0 commit comments