@doc-kit/core 0.0.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/CHANGELOG.md +87 -0
  2. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,92 @@
1
1
  # @doc-kit/core
2
2
 
3
+ ## 1.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - [#961](https://github.com/nodejs/doc-kit/pull/961) [`c334823`](https://github.com/nodejs/doc-kit/commit/c334823a1ee7c1dc4642fa1b0dad90912de22f17) Thanks [@avivkeller](https://github.com/avivkeller)! - The doc-kit engine and CLI, previously published together as
8
+ `@node-core/doc-kit`, are now published as two packages: `@doc-kit/core`
9
+ (the engine) and `@doc-kit/cli` (the `doc-kit` command-line interface).
10
+ The `@node-core/doc-kit` name now contains only the Node.js-specific
11
+ generators (`api-links`, `addon-verify`, and `man-page`).
12
+
13
+ - [#960](https://github.com/nodejs/doc-kit/pull/960) [`c734403`](https://github.com/nodejs/doc-kit/commit/c7344034d83dd5858250a5cc386fbe729f07ede0) Thanks [@avivkeller](https://github.com/avivkeller)! - The legacy-format generators (`legacy-html`, `legacy-html-all`,
14
+ `legacy-json`, and `legacy-json-all`) now live in the new
15
+ `@node-core/doc-kit-legacy` package and are loaded via import specifiers such
16
+ as `@node-core/doc-kit-legacy/legacy-html`. The corresponding
17
+ `@doc-kit/core/*` package exports have been removed. The CLI shorthand
18
+ names are unchanged.
19
+
20
+ - [#961](https://github.com/nodejs/doc-kit/pull/961) [`c334823`](https://github.com/nodejs/doc-kit/commit/c334823a1ee7c1dc4642fa1b0dad90912de22f17) Thanks [@avivkeller](https://github.com/avivkeller)! - The Node.js-specific generators (`api-links`, `addon-verify`, and
21
+ `man-page`) now live in the `@node-core/doc-kit` package and are loaded
22
+ via import specifiers such as `@node-core/doc-kit/man-page`. The
23
+ corresponding package exports have been removed from the doc-kit engine.
24
+ The CLI shorthand names are unchanged.
25
+
26
+ - [#959](https://github.com/nodejs/doc-kit/pull/959) [`ca36039`](https://github.com/nodejs/doc-kit/commit/ca3603916bee58fb80c1ea3a2e0023c13903fc63) Thanks [@avivkeller](https://github.com/avivkeller)! - The React/JSX-based generators (`html` — previously `web` —, `jsx-ast`,
27
+ `llms-txt`, `sitemap`, and `orama-db`) now live in the new
28
+ `@doc-kit/generator-react` package and are loaded via import specifiers such as
29
+ `@doc-kit/generator-react/html`. The corresponding `@doc-kit/core/*`
30
+ package exports have been removed. The `web` generator is renamed to `html`:
31
+ the CLI shorthand `web` keeps working as a deprecated alias, but the
32
+ configuration key is now `html` instead of `web`.
33
+
34
+ ### Minor Changes
35
+
36
+ - [#939](https://github.com/nodejs/doc-kit/pull/939) [`7bd1b5b`](https://github.com/nodejs/doc-kit/commit/7bd1b5b15ba2a444bd9e746fb36236030919b273) Thanks [@avivkeller](https://github.com/avivkeller)! - Discover and load configuration files with `cosmiconfig`.
37
+
38
+ - [#911](https://github.com/nodejs/doc-kit/pull/911) [`ada6540`](https://github.com/nodejs/doc-kit/commit/ada6540fe6c2c32cfa254187c159941b245ebf80) Thanks [@avivkeller](https://github.com/avivkeller)! - Add banner opt-out
39
+
40
+ - [#958](https://github.com/nodejs/doc-kit/pull/958) [`0bd347d`](https://github.com/nodejs/doc-kit/commit/0bd347da847e21c2501732c0acbdee7db1b0f8f1) Thanks [@avivkeller](https://github.com/avivkeller)! - Generators are now loaded dynamically by import specifier instead of a static
41
+ registry. `--target` accepts either a built-in shorthand name (`web`,
42
+ `legacy-html`, …) or any import specifier resolving to a generator module
43
+ (e.g. `some-package/generator` or `./my-generator.mjs`), and a generator's
44
+ `dependsOn` is now a full import specifier. This lays the groundwork for
45
+ splitting the built-in generators into separate packages and enables
46
+ third-party generator packages.
47
+
48
+ - [#937](https://github.com/nodejs/doc-kit/pull/937) [`43a09f7`](https://github.com/nodejs/doc-kit/commit/43a09f7ae9cdd4a1863e98b067abcf104e8937f2) Thanks [@avivkeller](https://github.com/avivkeller)! - Make the `web` generator bundler-neutral through a custom adapter contract,
49
+ with Vite 8.1 provided as the default adapter.
50
+
51
+ ### Patch Changes
52
+
53
+ - [#964](https://github.com/nodejs/doc-kit/pull/964) [`96e1c26`](https://github.com/nodejs/doc-kit/commit/96e1c26482098aec1753d5fb1aeacb607f7e097f) Thanks [@avivkeller](https://github.com/avivkeller)! - Add `web.navigation`, which supplies the sidebar groups (`navigation.sidebar`)
54
+ and the navigation bar items (`navigation.navbar`) from configuration.
55
+
56
+ - [#955](https://github.com/nodejs/doc-kit/pull/955) [`b80958f`](https://github.com/nodejs/doc-kit/commit/b80958ff53dd2388d33ce8ed282b14a67d3374f0) Thanks [@avivkeller](https://github.com/avivkeller)! - Close Orama search when the target link is on the same page
57
+
58
+ - [#968](https://github.com/nodejs/doc-kit/pull/968) [`d3306a2`](https://github.com/nodejs/doc-kit/commit/d3306a20bf913d2c83739215bc5692434ceef166) Thanks [@pimterry](https://github.com/pimterry)! - 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.
59
+
60
+ - [#889](https://github.com/nodejs/doc-kit/pull/889) [`68751af`](https://github.com/nodejs/doc-kit/commit/68751af17a45cc0c8e76d36308fb1be3f1dec4af) Thanks [@bmuenzenmeyer](https://github.com/bmuenzenmeyer)! - Fix `relative()` URL resolution when the target path is a prefix of the current
61
+ page's path (e.g. `/generators` from `/generators/web`): the target's final
62
+ segment was consumed as a common directory, producing `.` instead of
63
+ `../generators`. Unreachable in flat page layouts; surfaced by sites with
64
+ nested input directories.
65
+
66
+ - [#945](https://github.com/nodejs/doc-kit/pull/945) [`70b7526`](https://github.com/nodejs/doc-kit/commit/70b75269e9d0ed6b199c217bb268de96e65645c9) Thanks [@avivkeller](https://github.com/avivkeller)! - Moved the package into a `packages/core` workspace.
67
+
68
+ - [#1002](https://github.com/nodejs/doc-kit/pull/1002) [`740b613`](https://github.com/nodejs/doc-kit/commit/740b613ded7326eada843c34809ea128c6a9d7b5) Thanks [@avivkeller](https://github.com/avivkeller)! - Defaults are now project-neutral instead of Node.js-specific
69
+
70
+ - [#946](https://github.com/nodejs/doc-kit/pull/946) [`9ab2840`](https://github.com/nodejs/doc-kit/commit/9ab2840559d2f04a6db6b29bbf6c6d470a1dde0b) Thanks [@btea](https://github.com/btea)! - Fix missing spaces in the riscv64 multithreading warning message, which
71
+ previously concatenated as "failures whenallocating" and "spaceon riscv64".
72
+
73
+ - [#933](https://github.com/nodejs/doc-kit/pull/933) [`b73b704`](https://github.com/nodejs/doc-kit/commit/b73b70474a2c499c1be315ebf2595e6932124e19) Thanks [@vsolano9](https://github.com/vsolano9)! - Use short `DEP` codes for deprecation heading anchors.
74
+
75
+ - [#942](https://github.com/nodejs/doc-kit/pull/942) [`cef45ca`](https://github.com/nodejs/doc-kit/commit/cef45caf14cba83c77c373f59cee7f33f9f3df9b) Thanks [@btea](https://github.com/btea)! - Space union separators in type annotation values (`{string|URL}` is now rendered as `string | URL`).
76
+
77
+ - [#934](https://github.com/nodejs/doc-kit/pull/934) [`e6f1769`](https://github.com/nodejs/doc-kit/commit/e6f176958f6323d054dc86c4437accc9340e6914) Thanks [@avivkeller](https://github.com/avivkeller)! - Switches `oxc-parser` for `@swc/wasm`, since `oxc-parser` does not provide the needed bindings.
78
+
79
+ - [#919](https://github.com/nodejs/doc-kit/pull/919) [`d0f0de0`](https://github.com/nodejs/doc-kit/commit/d0f0de069e9061b6684269b412029bdd3dd288ba) Thanks [@MFA-G](https://github.com/MFA-G)! - Preserve deprecation codes in generated table-of-contents labels.
80
+
81
+ - [#963](https://github.com/nodejs/doc-kit/pull/963) [`2f9defe`](https://github.com/nodejs/doc-kit/commit/2f9defe49cac2d0e95c6fb213075291509a50a5f) Thanks [@btea](https://github.com/btea)! - Sync the URL hash when following same-page search hits
82
+
83
+ - [#955](https://github.com/nodejs/doc-kit/pull/955) [`b80958f`](https://github.com/nodejs/doc-kit/commit/b80958ff53dd2388d33ce8ed282b14a67d3374f0) Thanks [@avivkeller](https://github.com/avivkeller)! - Render markdown `code` snippets in the sidebar
84
+
85
+ - Updated dependencies [[`1da2390`](https://github.com/nodejs/doc-kit/commit/1da239076622e792145a38d2045dee404c3ad75f), [`c734403`](https://github.com/nodejs/doc-kit/commit/c7344034d83dd5858250a5cc386fbe729f07ede0), [`4bafb28`](https://github.com/nodejs/doc-kit/commit/4bafb287eda25dc07be9525e16aa6bfc63ebad1d), [`c334823`](https://github.com/nodejs/doc-kit/commit/c334823a1ee7c1dc4642fa1b0dad90912de22f17), [`740b613`](https://github.com/nodejs/doc-kit/commit/740b613ded7326eada843c34809ea128c6a9d7b5), [`740b613`](https://github.com/nodejs/doc-kit/commit/740b613ded7326eada843c34809ea128c6a9d7b5), [`43673d1`](https://github.com/nodejs/doc-kit/commit/43673d1785642cd26a3c6b5406a34d9eea42c68d), [`bfa8f0e`](https://github.com/nodejs/doc-kit/commit/bfa8f0e3bb49cba6bcbe780a61caf3e785bcb23b), [`ca36039`](https://github.com/nodejs/doc-kit/commit/ca3603916bee58fb80c1ea3a2e0023c13903fc63)]:
86
+ - @doc-kit/generator-react@0.1.0
87
+ - @node-core/doc-kit-legacy@1.0.0
88
+ - @node-core/doc-kit@2.0.0
89
+
3
90
  ## 1.4.3
4
91
 
5
92
  ### Patch Changes
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@doc-kit/core",
3
3
  "type": "module",
4
- "version": "0.0.0",
4
+ "version": "1.0.0",
5
5
  "description": "The doc-kit engine: the pipeline and shared APIs that power the doc-kit generators and CLI",
6
6
  "repository": {
7
7
  "type": "git",
@@ -64,9 +64,9 @@
64
64
  "hast-util-to-string": "^3.0.1"
65
65
  },
66
66
  "peerDependencies": {
67
- "@node-core/doc-kit": "1.4.3",
68
- "@node-core/doc-kit-legacy": "0.0.0",
69
- "@doc-kit/generator-react": "0.0.0"
67
+ "@node-core/doc-kit": "2.0.0",
68
+ "@node-core/doc-kit-legacy": "1.0.0",
69
+ "@doc-kit/generator-react": "0.1.0"
70
70
  },
71
71
  "peerDependenciesMeta": {
72
72
  "@node-core/doc-kit": {