Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/configurable-navigation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
'@node-core/doc-kit': patch
'@nodejs/doc-kit': patch
---

Add `web.navigation`, which supplies the sidebar groups (`navigation.sidebar`)
Expand Down
2 changes: 1 addition & 1 deletion .changeset/curvy-items-smile.md
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`.
2 changes: 1 addition & 1 deletion .changeset/did-you-know-that-the-world-is-round.md
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
2 changes: 1 addition & 1 deletion .changeset/display-name-type-unions.md
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.
8 changes: 8 additions & 0 deletions .changeset/doc-kit-scope-move.md
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`).
2 changes: 1 addition & 1 deletion .changeset/fix-relative-parent-path.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
'@node-core/doc-kit': patch
'@nodejs/doc-kit': patch
---

Fix `relative()` URL resolution when the target path is a prefix of the current
Expand Down
4 changes: 2 additions & 2 deletions .changeset/legacy-kitten-package.md
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.
2 changes: 1 addition & 1 deletion .changeset/monorepo-layout.md
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.
10 changes: 10 additions & 0 deletions .changeset/node-kitten-package.md
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.
2 changes: 1 addition & 1 deletion .changeset/opt-out-banners.md
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
4 changes: 2 additions & 2 deletions .changeset/react-kitten-package.md
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`.
2 changes: 1 addition & 1 deletion .changeset/riscv64-warning-spacing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
'@node-core/doc-kit': patch
'@nodejs/doc-kit': patch
---

Fix missing spaces in the riscv64 multithreading warning message, which
Expand Down
2 changes: 1 addition & 1 deletion .changeset/short-deprecation-links.md
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.
2 changes: 1 addition & 1 deletion .changeset/spaced-union-types.md
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`).
2 changes: 1 addition & 1 deletion .changeset/specifier-generator-loading.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
'@node-core/doc-kit': minor
'@nodejs/doc-kit': minor
---

Generators are now loaded dynamically by import specifier instead of a static
Expand Down
2 changes: 1 addition & 1 deletion .changeset/swc.md
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.
2 changes: 1 addition & 1 deletion .changeset/tidy-deprecations-smile.md
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.
2 changes: 1 addition & 1 deletion .changeset/tidy-donuts-search.md
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
2 changes: 1 addition & 1 deletion .changeset/vite-web-generator.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
'@node-core/doc-kit': minor
'@nodejs/doc-kit': minor
---

Make the `web` generator bundler-neutral through a custom adapter contract,
Expand Down
2 changes: 1 addition & 1 deletion .changeset/yes-i-did-know-that-thank-you.md
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
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ jobs:
env:
SLACK_COLOR: '#43853D'
SLACK_ICON: https://github.com/nodejs.png?size=48
SLACK_TITLE: ':rocket: Package Published: @node-core/doc-kit'
SLACK_TITLE: ':rocket: doc-kit Packages Published'
SLACK_MESSAGE: |
:package: *Package*: `@node-core/doc-kit` (<https://www.npmjs.com/package/@node-core/doc-kit|View on npm>)
:package: *Packages*: `nodejs/doc-kit` workspace (<https://www.npmjs.com/package/@nodejs/doc-kit|@nodejs/doc-kit on npm>)
:bust_in_silhouette: *Published by*: ${{ github.triggering_actor }}
:octocat: *Commit*: <https://github.com/${{ github.repository }}/commit/${{ github.sha }}|${{ github.sha }}>
SLACK_USERNAME: nodejs-bot
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ junit.xml
isolate-*

# Node's Source Folder
node
/node

# Playwright
playwright-report/
Expand Down
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
npm-shrinkwrap.json

# Tests files
packages/core/src/generators/api-links/__tests__/fixtures/
packages/node/src/api-links/__tests__/fixtures/
*.snapshot

# Templates
Expand Down
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `@node-core/doc-kit` Contributing Guide
# `@nodejs/doc-kit` Contributing Guide

Thank you for your interest in contributing to the `@node-core/doc-kit` project! We welcome contributions from everyone, and we appreciate your help in making this project better.
Thank you for your interest in contributing to the `@nodejs/doc-kit` project! We welcome contributions from everyone, and we appreciate your help in making this project better.

## Table of Contents

Expand Down Expand Up @@ -29,7 +29,7 @@ Thank you for your interest in contributing to the `@node-core/doc-kit` project!

## Getting Started

The steps below will give you a general idea of how to prepare your local environment for the `@node-core/doc-kit` project and general steps for getting things done and landing your contribution.
The steps below will give you a general idea of how to prepare your local environment for the `@nodejs/doc-kit` project and general steps for getting things done and landing your contribution.

### Prerequisites

Expand Down Expand Up @@ -77,7 +77,10 @@ This repository is an npm workspaces monorepo. The root package is private and
holds the shared tooling (linting, formatting, tests, changesets); every
published package lives under `packages/`:

- `packages/core`: [`@node-core/doc-kit`](packages/core)
- `packages/core`: [`@nodejs/doc-kit`](packages/core) — the doc-kit engine and CLI
- `packages/legacy`: [`@nodejs/doc-kit-generator-legacy`](packages/legacy) — the legacy-format generators
- `packages/node`: [`@node-core/doc-kit`](packages/node) — the Node.js-specific generators
- `packages/react`: [`@nodejs/doc-kit-generator-react`](packages/react) — the React/JSX-based generators

Everything else at the root supports the repo rather than shipping to npm:
`docs/` (the reference docs), `www/` (the documentation site), `scripts/` (build
Expand Down Expand Up @@ -357,7 +360,7 @@ version in `package.json`, and writes the corresponding `CHANGELOG.md` entries.

To ship a release, a maintainer merges that "Version Packages" PR. The same workflow then:

- publishes `@node-core/doc-kit` to npm (via [npm trusted publishing][] — no token required),
- publishes the workspace packages to npm (via [npm trusted publishing][] — no token required),
- creates the matching `v<x.y.z>` git tag, and
- cuts a GitHub Release from the changelog.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</p>

<p align="center">
<code>@node-core/doc-kit</code> is a tool to generate API documentation of Node.js. <a href="https://github.com/nodejs/node/issues/52343">See this issue</a> for more information.
<code>@nodejs/doc-kit</code> is a tool to generate API documentation of Node.js. <a href="https://github.com/nodejs/node/issues/52343">See this issue</a> for more information.
</p>

<p align="center">
Expand Down Expand Up @@ -44,7 +44,7 @@ $ node packages/core/bin/cli.mjs --help
```

```
Usage: @node-core/doc-kit [options] [command]
Usage: @nodejs/doc-kit [options] [command]

CLI tool to generate the Node.js API documentation

Expand All @@ -65,7 +65,7 @@ Running `generate` without the required values exits with an error pointing you
to the help output.

```
Usage: @node-core/doc-kit generate [options]
Usage: @nodejs/doc-kit generate [options]

Generate API docs

Expand Down
2 changes: 1 addition & 1 deletion docs/comparators.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Creating Comparators

This guide explains how to create build comparison scripts for `@node-core/doc-kit`. Comparators help identify differences between documentation builds, useful for CI/CD and regression testing.
This guide explains how to create build comparison scripts for `@nodejs/doc-kit`. Comparators help identify differences between documentation builds, useful for CI/CD and regression testing.

## Comparator Concepts

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export default {
// Targets, alternatively supplied by command line flags. Each entry is
// either a built-in shorthand name or an import specifier resolving to a
// generator module (e.g. '@my-scope/my-package/my-generator').
target: ['orama-db', 'web'],
target: ['orama-db', 'html'],
global: {
version: '20.0.0',
minify: true,
Expand Down
18 changes: 9 additions & 9 deletions docs/generators.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Creating Generators

This guide explains how to create new documentation generators for `@node-core/doc-kit`.
This guide explains how to create new documentation generators for `@nodejs/doc-kit`.

## Generator Concepts

Expand Down Expand Up @@ -88,7 +88,7 @@ export default {

// This generator depends on the metadata generator. Dependencies are
// declared as import specifiers, so they can live in any package.
dependsOn: '@node-core/doc-kit/metadata',
dependsOn: '@nodejs/doc-kit/metadata',

defaultConfiguration: {
// If your generator supports a custom configuration, define the defaults here
Expand Down Expand Up @@ -170,8 +170,8 @@ the import specifier it resolves to:

```javascript
export const publicGenerators = {
'json-simple': '@node-core/doc-kit/json-simple',
'my-format': '@node-core/doc-kit/my-format', // Add this
'json-simple': '@nodejs/doc-kit/json-simple',
'my-format': '@nodejs/doc-kit/my-format', // Add this
// ... other generators
};
```
Expand Down Expand Up @@ -199,7 +199,7 @@ export default {

description: 'Processes data in parallel',

dependsOn: '@node-core/doc-kit/metadata',
dependsOn: '@nodejs/doc-kit/metadata',

// Indicates this generator has a processChunk implementation
hasParallelProcessor: true,
Expand Down Expand Up @@ -296,7 +296,7 @@ export default {

description: 'Streams results as they are ready',

dependsOn: '@node-core/doc-kit/metadata',
dependsOn: '@nodejs/doc-kit/metadata',

hasParallelProcessor: true,

Expand Down Expand Up @@ -403,7 +403,7 @@ export default {

// This generator requires the metadata generator's output. The dependency
// is an import specifier, so it may point at any installed package.
dependsOn: '@node-core/doc-kit/metadata',
dependsOn: '@nodejs/doc-kit/metadata',

// ... other metadata

Expand Down Expand Up @@ -434,15 +434,15 @@ export default {
// packages/core/src/generators/metadata/index.mjs
export default {
name: 'metadata',
dependsOn: '@node-core/doc-kit/ast', // Depends on AST
dependsOn: '@nodejs/doc-kit/ast', // Depends on AST
// Processes AST output
};

// Step 3: Generate HTML from metadata
// packages/core/src/generators/html-generator/index.mjs
export default {
name: 'html-generator',
dependsOn: '@node-core/doc-kit/metadata', // Depends on metadata
dependsOn: '@nodejs/doc-kit/metadata', // Depends on metadata
// Processes metadata output
};
```
Expand Down
2 changes: 1 addition & 1 deletion docs/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
**Authored By**: Aviv Keller (<me@aviv.sh>)

This document specifies the Markdown format consumed by
[`@node-core/doc-kit`][doc-kit]. It defines the structural, syntactic, and
[`@nodejs/doc-kit`][doc-kit]. It defines the structural, syntactic, and
semantic rules that documents MUST follow to be correctly parsed. The format
is a strict superset of [GitHub Flavored Markdown][gfm] (which itself is a
strict superset of [CommonMark][commonmark]), adding conventions for API
Expand Down
2 changes: 1 addition & 1 deletion eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default defineConfig([
ignores: [
'www/out',
'out/',
'packages/core/src/generators/api-links/__tests__/fixtures/',
'packages/node/src/api-links/__tests__/fixtures/',
Comment thread
cursor[bot] marked this conversation as resolved.
],
},
{
Expand Down
Loading
Loading