-
Notifications
You must be signed in to change notification settings - Fork 58
refactor(node): extract @node-core/doc-kit package, move core to @nodejs/doc-kit #961
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| '@node-core/doc-kit': minor | ||
| '@nodejs/doc-kit': minor | ||
| --- | ||
|
|
||
| Discover and load configuration files with `cosmiconfig`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,11 @@ | ||
| --- | ||
| '@nodejs/doc-kit-generator-legacy': major | ||
| '@node-core/doc-kit': 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 | ||
| `@node-core/doc-kit/*` package exports have been removed. The CLI shorthand | ||
| `@nodejs/doc-kit/*` package exports have been removed. The CLI shorthand | ||
| names are unchanged. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| '@node-core/doc-kit': patch | ||
| '@nodejs/doc-kit': patch | ||
| --- | ||
|
|
||
| Moved the package into a `packages/core` workspace. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| '@node-core/doc-kit': minor | ||
| '@nodejs/doc-kit': minor | ||
| --- | ||
|
|
||
| Add banner opt-out |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| --- | ||
| '@nodejs/doc-kit-generator-react': minor | ||
| '@node-core/doc-kit': major | ||
| '@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 `@node-core/doc-kit/*` | ||
| `@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`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| '@node-core/doc-kit': patch | ||
| '@nodejs/doc-kit': patch | ||
| --- | ||
|
|
||
| Use short `DEP` codes for deprecation heading anchors. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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`). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| '@node-core/doc-kit': patch | ||
| '@nodejs/doc-kit': patch | ||
| --- | ||
|
|
||
| Preserve deprecation codes in generated table-of-contents labels. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| '@node-core/doc-kit': patch | ||
| '@nodejs/doc-kit': patch | ||
| --- | ||
|
|
||
| Sync the URL hash when following same-page search hits |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| '@node-core/doc-kit': patch | ||
| '@nodejs/doc-kit': patch | ||
| --- | ||
|
|
||
| Render markdown `code` snippets in the sidebar |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,7 +18,7 @@ junit.xml | |
| isolate-* | ||
|
|
||
| # Node's Source Folder | ||
| node | ||
| /node | ||
|
|
||
| # Playwright | ||
| playwright-report/ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.