Skip to content

Releases: nodejs/doc-kit

@node-core/doc-kit@2.0.0

Choose a tag to compare

@github-actions github-actions released this 10 Aug 13:46
Immutable release. Only release title and notes can be modified.
f46a0bd

Major Changes

  • #961 c334823 Thanks @avivkeller! - 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.

Minor Changes

Patch Changes

@doc-kit/generator-react@0.1.0

Choose a tag to compare

@github-actions github-actions released this 10 Aug 13:49
Immutable release. Only release title and notes can be modified.
f46a0bd

Minor Changes

  • #1002 740b613 Thanks @avivkeller! - Defaults are now project-neutral instead of Node.js-specific

  • #959 ca36039 Thanks @avivkeller! - The React/JSX-based generators (html — previously web —, jsx-ast,
    llms-txt, sitemap, and orama-db) now live in the new
    @doc-kit/generator-react package and are loaded via import specifiers such as
    @doc-kit/generator-react/html. The corresponding @doc-kit/core/*
    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.

Patch Changes

@doc-kit/core@1.0.0

Choose a tag to compare

@github-actions github-actions released this 10 Aug 13:49
Immutable release. Only release title and notes can be modified.
f46a0bd

Major Changes

  • #961 c334823 Thanks @avivkeller! - The doc-kit engine and CLI, previously published together as
    @node-core/doc-kit, are now published as two packages: @doc-kit/core
    (the engine) and @doc-kit/cli (the doc-kit command-line interface).
    The @node-core/doc-kit name now contains only the Node.js-specific
    generators (api-links, addon-verify, and man-page).

  • #960 c734403 Thanks @avivkeller! - The legacy-format generators (legacy-html, legacy-html-all,
    legacy-json, and legacy-json-all) now live in the new
    @node-core/doc-kit-legacy package and are loaded via import specifiers such
    as @node-core/doc-kit-legacy/legacy-html. The corresponding
    @doc-kit/core/* package exports have been removed. The CLI shorthand
    names are unchanged.

  • #961 c334823 Thanks @avivkeller! - 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.

  • #959 ca36039 Thanks @avivkeller! - The React/JSX-based generators (html — previously web —, jsx-ast,
    llms-txt, sitemap, and orama-db) now live in the new
    @doc-kit/generator-react package and are loaded via import specifiers such as
    @doc-kit/generator-react/html. The corresponding @doc-kit/core/*
    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.

Minor Changes

  • #939 7bd1b5b Thanks @avivkeller! - Discover and load configuration files with cosmiconfig.

  • #911 ada6540 Thanks @avivkeller! - Add banner opt-out

  • #958 0bd347d Thanks @avivkeller! - Generators are now loaded dynamically by import specifier instead of a static
    registry. --target accepts either a built-in shorthand name (web,
    legacy-html, …) or any import specifier resolving to a generator module
    (e.g. some-package/generator or ./my-generator.mjs), and a generator's
    dependsOn is now a full import specifier. This lays the groundwork for
    splitting the built-in generators into separate packages and enables
    third-party generator packages.

  • #937 43a09f7 Thanks @avivkeller! - Make the web generator bundler-neutral through a custom adapter contract,
    with Vite 8.1 provided as the default adapter.

Patch Changes

  • #964 96e1c26 Thanks @avivkeller! - Add web.navigation, which supplies the sidebar groups (navigation.sidebar)
    and the navigation bar items (navigation.navbar) from configuration.

  • #955 b80958f Thanks @avivkeller! - Close Orama search when the target link is on the same page

  • #968 d3306a2 Thanks @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.

  • #889 68751af Thanks @bmuenzenmeyer! - Fix relative() URL resolution when the target path is a prefix of the current
    page's path (e.g. /generators from /generators/web): the target's final
    segment was consumed as a common directory, producing . instead of
    ../generators. Unreachable in flat page layouts; surfaced by sites with
    nested input directories.

  • #945 70b7526 Thanks @avivkeller! - Moved the package into a packages/core workspace.

  • #1002 740b613 Thanks @avivkeller! - Defaults are now project-neutral instead of Node.js-specific

  • #946 9ab2840 Thanks @btea! - Fix missing spaces in the riscv64 multithreading warning message, which
    previously concatenated as "failures whenallocating" and "spaceon riscv64".

  • #933 b73b704 Thanks @vsolano9! - Use short DEP codes for deprecation heading anchors.

  • #942 cef45ca Thanks @btea! - Space union separators in type annotation values ({string|URL} is now rendered as string | URL).

  • #934 e6f1769 Thanks @avivkeller! - Switches oxc-parser for @swc/wasm, since oxc-parser does not provide the needed bindings.

  • #919 d0f0de0 Thanks @MFA-G! - Preserve deprecation codes in generated table-of-contents labels.

  • #963 2f9defe Thanks @btea! - Sync the URL hash when following same-page search hits

  • #955 b80958f Thanks @avivkeller! - Render markdown code snippets in the sidebar

  • Updated dependencies [1da2390, c734403, 4bafb28, c334823, 740b613, 740b613, 43673d1, bfa8f0e, ca36039]:

    • @doc-kit/generator-react@0.1.0
    • @node-core/doc-kit-legacy@1.0.0
    • @node-core/doc-kit@2.0.0

@doc-kit/cli@1.0.0

Choose a tag to compare

@github-actions github-actions released this 10 Aug 13:49
Immutable release. Only release title and notes can be modified.
f46a0bd

Major Changes

  • #961 c334823 Thanks @avivkeller! - The doc-kit engine and CLI, previously published together as
    @node-core/doc-kit, are now published as two packages: @doc-kit/core
    (the engine) and @doc-kit/cli (the doc-kit command-line interface).
    The @node-core/doc-kit name now contains only the Node.js-specific
    generators (api-links, addon-verify, and man-page).

Patch Changes

v1.4.3

Choose a tag to compare

@github-actions github-actions released this 15 Jul 19:12
Immutable release. Only release title and notes can be modified.
4534824

Patch Changes

  • #905 f214a00 Thanks @avivkeller! - Allow for the specification of dynamically generated configuration values

v1.4.2

Choose a tag to compare

@github-actions github-actions released this 13 Jul 14:10
4f07fee

Patch Changes

  • #855 d7bdf39 Thanks @bmuenzenmeyer! - Adopt Changesets for releases: versioning and publishing are now driven by changeset files, which
    produce a CHANGELOG.md, git tags, and GitHub Releases.

  • #895 9d7ce14 Thanks @avivkeller! - Avoids directly mutating the AST in legacy-json, as to ensure future generators do not run with a input different than they expect.