diff --git a/.changeset/change-history-label-and-scrollbar.md b/.changeset/change-history-label-and-scrollbar.md deleted file mode 100644 index 42e84814..00000000 --- a/.changeset/change-history-label-and-scrollbar.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -'@doc-kit/generator-react': patch ---- - -Fix `[object Object]` in ChangeHistory aria-label and dropdown horizontal scrollbar - -- Change history labels were passing a JSX AST object instead of a plain text - string to the `ChangeHistory` component, causing `aria-label` to render as - `[object Object]`. Labels are now extracted as plain text via `remark-parse`. -- The ChangeHistory dropdown could show a horizontal scrollbar when label text - overflowed the fixed-width container. Added `overflow-wrap` and `word-break` - rules to prevent this. diff --git a/.changeset/constructor-return-types.md b/.changeset/constructor-return-types.md deleted file mode 100644 index b58e256e..00000000 --- a/.changeset/constructor-return-types.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@doc-kit/generator-react': patch ---- - -Constructors now render their own class as the return type instead of `void` diff --git a/.changeset/fix-typed-list-split.md b/.changeset/fix-typed-list-split.md deleted file mode 100644 index ced5172d..00000000 --- a/.changeset/fix-typed-list-split.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -'@doc-kit/core': patch -'@doc-kit/generator-react': patch ---- - -Fix empty paragraphs in API docs when a typed parameter list contains trailing non-parameter items - -When a loose markdown list in the API docs starts with typed parameters (e.g. `actual`, `expected`, `Returns`) but also contains plain prose bullets (e.g. algorithm complexity notes), the entire list was previously treated as a parameter signature table. The non-parameter items had no name or type, causing them to render as empty `
` blocks on the built site. - -The fix splits the list at the first non-parameter item: typed items become the `FunctionSignature` table, and the remaining items render as regular markdown content. diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index 927a2e91..337fac62 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -1,5 +1,12 @@ # @doc-kit/cli +## 1.0.1 + +### Patch Changes + +- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]: + - @doc-kit/core@1.0.1 + ## 1.0.0 ### Major Changes diff --git a/packages/cli/package.json b/packages/cli/package.json index eb40b6c6..2a16e115 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,7 +1,7 @@ { "name": "@doc-kit/cli", "type": "module", - "version": "1.0.0", + "version": "1.0.1", "description": "The doc-kit command-line interface: runs @doc-kit/core generators from the terminal", "repository": { "type": "git", diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index c96f74ff..634f4d78 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,20 @@ # @doc-kit/core +## 1.0.1 + +### Patch Changes + +- [#1023](https://github.com/nodejs/doc-kit/pull/1023) [`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c) Thanks [@btea](https://github.com/btea)! - Fix empty paragraphs in API docs when a typed parameter list contains trailing non-parameter items + + When a loose markdown list in the API docs starts with typed parameters (e.g. `actual`, `expected`, `Returns`) but also contains plain prose bullets (e.g. algorithm complexity notes), the entire list was previously treated as a parameter signature table. The non-parameter items had no name or type, causing them to render as empty `
` blocks on the built site. + + The fix splits the list at the first non-parameter item: typed items become the `FunctionSignature` table, and the remaining items render as regular markdown content. + +- Updated dependencies [[`2a106f3`](https://github.com/nodejs/doc-kit/commit/2a106f3b40729b4ec9f6dbec739d14c67c1bd28b), [`49cb713`](https://github.com/nodejs/doc-kit/commit/49cb713d359cd1dd04268781b382d75297d23cdc), [`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]: + - @doc-kit/generator-react@0.1.1 + - @node-core/doc-kit@2.0.1 + - @node-core/doc-kit-legacy@1.0.1 + ## 1.0.0 ### Major Changes diff --git a/packages/core/package.json b/packages/core/package.json index 8813bc01..10b5b6ac 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,7 +1,7 @@ { "name": "@doc-kit/core", "type": "module", - "version": "1.0.0", + "version": "1.0.1", "description": "The doc-kit engine: the pipeline and shared APIs that power the doc-kit generators and CLI", "repository": { "type": "git", diff --git a/packages/node-legacy/CHANGELOG.md b/packages/node-legacy/CHANGELOG.md index 7759fa7b..f0bbfd67 100644 --- a/packages/node-legacy/CHANGELOG.md +++ b/packages/node-legacy/CHANGELOG.md @@ -1,5 +1,12 @@ # @node-core/doc-kit-legacy +## 1.0.1 + +### Patch Changes + +- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]: + - @doc-kit/core@1.0.1 + ## 1.0.0 ### Major Changes diff --git a/packages/node-legacy/package.json b/packages/node-legacy/package.json index edf0634b..6dfdc640 100644 --- a/packages/node-legacy/package.json +++ b/packages/node-legacy/package.json @@ -1,7 +1,7 @@ { "name": "@node-core/doc-kit-legacy", "type": "module", - "version": "1.0.0", + "version": "1.0.1", "description": "Node.js legacy-format generators for @doc-kit/core: legacy-html, legacy-html-all, legacy-json, and legacy-json-all", "repository": { "type": "git", diff --git a/packages/node/CHANGELOG.md b/packages/node/CHANGELOG.md index 35ba3e05..ba73186c 100644 --- a/packages/node/CHANGELOG.md +++ b/packages/node/CHANGELOG.md @@ -1,5 +1,12 @@ # @node-core/doc-kit +## 2.0.1 + +### Patch Changes + +- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]: + - @doc-kit/core@1.0.1 + ## 2.0.0 ### Major Changes diff --git a/packages/node/package.json b/packages/node/package.json index ec86e9e8..bd82a44c 100644 --- a/packages/node/package.json +++ b/packages/node/package.json @@ -1,7 +1,7 @@ { "name": "@node-core/doc-kit", "type": "module", - "version": "2.0.0", + "version": "2.0.1", "description": "Node.js-specific generators for @doc-kit/core: api-links, addon-verify, and man-page", "repository": { "type": "git", diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md index 3cfe9c23..2ea81d2d 100644 --- a/packages/react/CHANGELOG.md +++ b/packages/react/CHANGELOG.md @@ -1,5 +1,29 @@ # @doc-kit/generator-react +## 0.1.1 + +### Patch Changes + +- [#1034](https://github.com/nodejs/doc-kit/pull/1034) [`2a106f3`](https://github.com/nodejs/doc-kit/commit/2a106f3b40729b4ec9f6dbec739d14c67c1bd28b) Thanks [@btea](https://github.com/btea)! - Fix `[object Object]` in ChangeHistory aria-label and dropdown horizontal scrollbar + + - Change history labels were passing a JSX AST object instead of a plain text + string to the `ChangeHistory` component, causing `aria-label` to render as + `[object Object]`. Labels are now extracted as plain text via `remark-parse`. + - The ChangeHistory dropdown could show a horizontal scrollbar when label text + overflowed the fixed-width container. Added `overflow-wrap` and `word-break` + rules to prevent this. + +- [#1037](https://github.com/nodejs/doc-kit/pull/1037) [`49cb713`](https://github.com/nodejs/doc-kit/commit/49cb713d359cd1dd04268781b382d75297d23cdc) Thanks [@pmarkert](https://github.com/pmarkert)! - Constructors now render their own class as the return type instead of `void` + +- [#1023](https://github.com/nodejs/doc-kit/pull/1023) [`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c) Thanks [@btea](https://github.com/btea)! - Fix empty paragraphs in API docs when a typed parameter list contains trailing non-parameter items + + When a loose markdown list in the API docs starts with typed parameters (e.g. `actual`, `expected`, `Returns`) but also contains plain prose bullets (e.g. algorithm complexity notes), the entire list was previously treated as a parameter signature table. The non-parameter items had no name or type, causing them to render as empty `
` blocks on the built site. + + The fix splits the list at the first non-parameter item: typed items become the `FunctionSignature` table, and the remaining items render as regular markdown content. + +- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]: + - @doc-kit/core@1.0.1 + ## 0.1.0 ### Minor Changes diff --git a/packages/react/package.json b/packages/react/package.json index a60ec0c5..5cf01fbc 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -1,7 +1,7 @@ { "name": "@doc-kit/generator-react", "type": "module", - "version": "0.1.0", + "version": "0.1.1", "description": "React/JSX-based generators for @doc-kit/core: html, jsx-ast, llms-txt, sitemap, and orama-db", "repository": { "type": "git",