Skip to content

Commit 90b752c

Browse files
committed
feat(monorepo): implement orchestrator
1 parent 4e07d04 commit 90b752c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1433
-1886
lines changed

.github/workflows/generate.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,36 +75,36 @@ jobs:
7575
fail-fast: false
7676
matrix:
7777
include:
78-
- target: man-page
78+
- target: '@node-core/doc-kit/generators/man-page'
7979
input: './node/doc/api/cli.md'
8080

81-
- target: addon-verify
81+
- target: '@node-core/doc-kit/generators/addon-verify'
8282
input: './node/doc/api/addons.md'
8383

84-
- target: api-links
84+
- target: '@node-core/doc-kit/generators/api-links'
8585
input: './node/lib/*.js'
8686
compare: object-assertion
8787

88-
- target: orama-db
88+
- target: '@node-core/doc-kit/generators/orama-db'
8989
input: './node/doc/api/*.md'
9090
compare: file-size
9191

92-
- target: json-simple
92+
- target: '@node-core/doc-kit/generators/json-simple'
9393
input: './node/doc/api/*.md'
9494

95-
- target: legacy-json
95+
- target: '@node-core/doc-kit/generators/legacy-json'
9696
input: './node/doc/api/*.md'
9797
compare: object-assertion
9898

99-
- target: legacy-html
99+
- target: '@node-core/doc-kit/generators/legacy-html'
100100
input: './node/doc/api/*.md'
101101
compare: file-size
102102

103-
- target: web
103+
- target: '@node-core/doc-kit/generators/web'
104104
input: './node/doc/api/*.md'
105105
compare: file-size
106106

107-
- target: llms-txt
107+
- target: '@node-core/doc-kit/generators/llms-txt'
108108
input: './node/doc/api/*.md'
109109
compare: file-size
110110
steps:

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Options:
6868
-v, --version <semver> Target Node.js version (default: "v22.14.0")
6969
-c, --changelog <url> Changelog URL or path (default: "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md")
7070
--git-ref <url> Git ref/commit URL (default: "https://github.com/nodejs/node/tree/HEAD")
71-
-t, --target [modes...] Target generator modes (choices: "json-simple", "legacy-html", "legacy-html-all", "man-page", "legacy-json", "legacy-json-all", "addon-verify", "api-links", "orama-db", "llms-txt")
71+
-t, --target <generator...> Target generator(s) (e.g. @node-core/doc-kit/generators/web)
7272
-h, --help display help for command
7373
```
7474

@@ -91,8 +91,8 @@ To generate a 1:1 match with the [legacy tooling](https://github.com/nodejs/node
9191

9292
```sh
9393
npx doc-kit generate \
94-
-t legacy-html \
95-
-t legacy-json \
94+
-t @node-core/doc-kit/generators/legacy-html \
95+
-t @node-core/doc-kit/generators/legacy-json \
9696
-i "path/to/node/doc/api/*.md" \
9797
-o out \
9898
--index path/to/node/doc/api/index.md
@@ -104,8 +104,8 @@ To generate [our redesigned documentation pages](https://nodejs-api-docs-tooling
104104

105105
```sh
106106
npx doc-kit generate \
107-
-t web \
108-
-t orama-db \
107+
-t @node-core/doc-kit/generators/web \
108+
-t @node-core/doc-kit/generators/orama-db \
109109
-i "path/to/node/doc/api/*.md" \
110110
-o out \
111111
--index path/to/node/doc/api/index.md

docs/configuration.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -100,17 +100,17 @@ Configurations are merged in the following order (earlier sources take precedenc
100100

101101
CLI options map to configuration properties:
102102

103-
| CLI Option | Config Property | Example |
104-
| ---------------------- | ------------------ | ------------------------- |
105-
| `--input <path>` | `global.input` | `--input src/` |
106-
| `--output <path>` | `global.output` | `--output dist/` |
107-
| `--ignore <pattern>` | `global.ignore[]` | `--ignore test/` |
108-
| `--minify` | `global.minify` | `--minify` |
109-
| `--git-ref <ref>` | `global.ref` | `--git-ref v20.0.0` |
110-
| `--version <version>` | `global.version` | `--version 20.0.0` |
111-
| `--changelog <url>` | `global.changelog` | `--changelog https://...` |
112-
| `--index <url>` | `global.index` | `--index file://...` |
113-
| `--type-map <map>` | `metadata.typeMap` | `--type-map file://...` |
114-
| `--target <generator>` | `target` | `--target json` |
115-
| `--threads <n>` | `threads` | `--threads 4` |
116-
| `--chunk-size <n>` | `chunkSize` | `--chunk-size 10` |
103+
| CLI Option | Config Property | Example |
104+
| ---------------------- | ------------------ | ---------------------------------------------------- |
105+
| `--input <path>` | `global.input` | `--input src/` |
106+
| `--output <path>` | `global.output` | `--output dist/` |
107+
| `--ignore <pattern>` | `global.ignore[]` | `--ignore test/` |
108+
| `--minify` | `global.minify` | `--minify` |
109+
| `--git-ref <ref>` | `global.ref` | `--git-ref v20.0.0` |
110+
| `--version <version>` | `global.version` | `--version 20.0.0` |
111+
| `--changelog <url>` | `global.changelog` | `--changelog https://...` |
112+
| `--index <url>` | `global.index` | `--index file://...` |
113+
| `--type-map <map>` | `metadata.typeMap` | `--type-map file://...` |
114+
| `--target <generator>` | `target` | `--target @node-core/doc-kit/generators/legacy-json` |
115+
| `--threads <n>` | `threads` | `--threads 4` |
116+
| `--chunk-size <n>` | `chunkSize` | `--chunk-size 10` |

0 commit comments

Comments
 (0)