Skip to content

Commit c32ed14

Browse files
Version Packages
1 parent 15b3f3e commit c32ed14

11 files changed

Lines changed: 54 additions & 15 deletions

File tree

.changeset/fix-typed-list-split.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

packages/cli/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# @doc-kit/cli
22

3+
## 1.0.1
4+
5+
### Patch Changes
6+
7+
- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]:
8+
- @doc-kit/core@1.0.1
9+
310
## 1.0.0
411

512
### Major Changes

packages/cli/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@doc-kit/cli",
33
"type": "module",
4-
"version": "1.0.0",
4+
"version": "1.0.1",
55
"description": "The doc-kit command-line interface: runs @doc-kit/core generators from the terminal",
66
"repository": {
77
"type": "git",

packages/core/CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# @doc-kit/core
22

3+
## 1.0.1
4+
5+
### Patch Changes
6+
7+
- [#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
8+
9+
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 `<section>` blocks on the built site.
10+
11+
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.
12+
13+
- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]:
14+
- @doc-kit/generator-react@0.1.1
15+
- @node-core/doc-kit@2.0.1
16+
- @node-core/doc-kit-legacy@1.0.1
17+
318
## 1.0.0
419

520
### Major Changes

packages/core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@doc-kit/core",
33
"type": "module",
4-
"version": "1.0.0",
4+
"version": "1.0.1",
55
"description": "The doc-kit engine: the pipeline and shared APIs that power the doc-kit generators and CLI",
66
"repository": {
77
"type": "git",

packages/node-legacy/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# @node-core/doc-kit-legacy
22

3+
## 1.0.1
4+
5+
### Patch Changes
6+
7+
- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]:
8+
- @doc-kit/core@1.0.1
9+
310
## 1.0.0
411

512
### Major Changes

packages/node-legacy/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@node-core/doc-kit-legacy",
33
"type": "module",
4-
"version": "1.0.0",
4+
"version": "1.0.1",
55
"description": "Node.js legacy-format generators for @doc-kit/core: legacy-html, legacy-html-all, legacy-json, and legacy-json-all",
66
"repository": {
77
"type": "git",

packages/node/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# @node-core/doc-kit
22

3+
## 2.0.1
4+
5+
### Patch Changes
6+
7+
- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]:
8+
- @doc-kit/core@1.0.1
9+
310
## 2.0.0
411

512
### Major Changes

packages/node/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@node-core/doc-kit",
33
"type": "module",
4-
"version": "2.0.0",
4+
"version": "2.0.1",
55
"description": "Node.js-specific generators for @doc-kit/core: api-links, addon-verify, and man-page",
66
"repository": {
77
"type": "git",

packages/react/CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# @doc-kit/generator-react
22

3+
## 0.1.1
4+
5+
### Patch Changes
6+
7+
- [#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
8+
9+
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 `<section>` blocks on the built site.
10+
11+
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.
12+
13+
- Updated dependencies [[`27a412a`](https://github.com/nodejs/doc-kit/commit/27a412ac35ab06e977b03b559e6525c0c5c5356c)]:
14+
- @doc-kit/core@1.0.1
15+
316
## 0.1.0
417

518
### Minor Changes

0 commit comments

Comments
 (0)