Releases: nodejs/doc-kit
Release list
@node-core/doc-kit@2.0.0
Major Changes
- #961
c334823Thanks @avivkeller! - The Node.js-specific generators (api-links,addon-verify, and
man-page) now live in the@node-core/doc-kitpackage 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
- #1002
740b613Thanks @avivkeller! - Add the@node-core/doc-kit/configpreset
Patch Changes
- #997
4bafb28Thanks @btea! - Pin theen-USlocale on builtin MDN type links that carry a hash fragment
(e.g.number,string,any). Locale-less MDN URLs redirect to the
visitor's preferred language, where heading anchor IDs are translated, so the
original fragment (e.g.#number_type) no longer matches any anchor on the
redirected page and the link fails to jump to the target section. - Updated dependencies [
96e1c26,7bd1b5b,b80958f,d3306a2,c334823,68751af,c734403,70b7526,c334823,ada6540,740b613,ca36039,9ab2840,b73b704,cef45ca,0bd347d,e6f1769,d0f0de0,2f9defe,43a09f7,b80958f]:- @doc-kit/core@1.0.0
@doc-kit/generator-react@0.1.0
Minor Changes
-
#1002
740b613Thanks @avivkeller! - Defaults are now project-neutral instead of Node.js-specific -
#959
ca36039Thanks @avivkeller! - The React/JSX-based generators (html— previouslyweb—,jsx-ast,
llms-txt,sitemap, andorama-db) now live in the new
@doc-kit/generator-reactpackage and are loaded via import specifiers such as
@doc-kit/generator-react/html. The corresponding@doc-kit/core/*
package exports have been removed. Thewebgenerator is renamed tohtml:
the CLI shorthandwebkeeps working as a deprecated alias, but the
configuration key is nowhtmlinstead ofweb.
Patch Changes
-
#1012
1da2390Thanks @avivkeller! - Adds support for cross-links, opt-in withshowCrossLinks: true -
#1015
43673d1Thanks @avivkeller! - Resolve the React→Preact aliases to absolute paths and anchor package imports
in generated virtual modules to the generator's own dependencies, so builds
work under isolated installs (pnpm) that don't hoist Preact and the UI
component packages to the project root. -
#1018
bfa8f0eThanks @avivkeller! - Preload the theme's fonts -
Updated dependencies [
96e1c26,7bd1b5b,b80958f,d3306a2,c334823,68751af,c734403,70b7526,c334823,ada6540,740b613,ca36039,9ab2840,b73b704,cef45ca,0bd347d,e6f1769,d0f0de0,2f9defe,43a09f7,b80958f]:- @doc-kit/core@1.0.0
@doc-kit/core@1.0.0
Major Changes
-
#961
c334823Thanks @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(thedoc-kitcommand-line interface).
The@node-core/doc-kitname now contains only the Node.js-specific
generators (api-links,addon-verify, andman-page). -
#960
c734403Thanks @avivkeller! - The legacy-format generators (legacy-html,legacy-html-all,
legacy-json, andlegacy-json-all) now live in the new
@node-core/doc-kit-legacypackage 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
c334823Thanks @avivkeller! - The Node.js-specific generators (api-links,addon-verify, and
man-page) now live in the@node-core/doc-kitpackage 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
ca36039Thanks @avivkeller! - The React/JSX-based generators (html— previouslyweb—,jsx-ast,
llms-txt,sitemap, andorama-db) now live in the new
@doc-kit/generator-reactpackage and are loaded via import specifiers such as
@doc-kit/generator-react/html. The corresponding@doc-kit/core/*
package exports have been removed. Thewebgenerator is renamed tohtml:
the CLI shorthandwebkeeps working as a deprecated alias, but the
configuration key is nowhtmlinstead ofweb.
Minor Changes
-
#939
7bd1b5bThanks @avivkeller! - Discover and load configuration files withcosmiconfig. -
#911
ada6540Thanks @avivkeller! - Add banner opt-out -
#958
0bd347dThanks @avivkeller! - Generators are now loaded dynamically by import specifier instead of a static
registry.--targetaccepts either a built-in shorthand name (web,
legacy-html, …) or any import specifier resolving to a generator module
(e.g.some-package/generatoror./my-generator.mjs), and a generator's
dependsOnis 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
43a09f7Thanks @avivkeller! - Make thewebgenerator bundler-neutral through a custom adapter contract,
with Vite 8.1 provided as the default adapter.
Patch Changes
-
#964
96e1c26Thanks @avivkeller! - Addweb.navigation, which supplies the sidebar groups (navigation.sidebar)
and the navigation bar items (navigation.navbar) from configuration. -
#955
b80958fThanks @avivkeller! - Close Orama search when the target link is on the same page -
#968
d3306a2Thanks @pimterry! - Resolve unions and arrays of display-name types ({HTTP/2 Headers Object | vm.Module},{HTTP/2 Headers Object[]}), and stop capturing prose such asU+007B ({), and U+007D (}).as a type annotation. -
#889
68751afThanks @bmuenzenmeyer! - Fixrelative()URL resolution when the target path is a prefix of the current
page's path (e.g./generatorsfrom/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
70b7526Thanks @avivkeller! - Moved the package into apackages/coreworkspace. -
#1002
740b613Thanks @avivkeller! - Defaults are now project-neutral instead of Node.js-specific -
#946
9ab2840Thanks @btea! - Fix missing spaces in the riscv64 multithreading warning message, which
previously concatenated as "failures whenallocating" and "spaceon riscv64". -
#933
b73b704Thanks @vsolano9! - Use shortDEPcodes for deprecation heading anchors. -
#942
cef45caThanks @btea! - Space union separators in type annotation values ({string|URL}is now rendered asstring | URL). -
#934
e6f1769Thanks @avivkeller! - Switchesoxc-parserfor@swc/wasm, sinceoxc-parserdoes not provide the needed bindings. -
#919
d0f0de0Thanks @MFA-G! - Preserve deprecation codes in generated table-of-contents labels. -
#963
2f9defeThanks @btea! - Sync the URL hash when following same-page search hits -
#955
b80958fThanks @avivkeller! - Render markdowncodesnippets 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
Major Changes
- #961
c334823Thanks @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(thedoc-kitcommand-line interface).
The@node-core/doc-kitname now contains only the Node.js-specific
generators (api-links,addon-verify, andman-page).
Patch Changes
v1.4.3
Patch Changes
- #905
f214a00Thanks @avivkeller! - Allow for the specification of dynamically generated configuration values
v1.4.2
Patch Changes
-
#855
d7bdf39Thanks @bmuenzenmeyer! - Adopt Changesets for releases: versioning and publishing are now driven by changeset files, which
produce aCHANGELOG.md, git tags, and GitHub Releases. -
#895
9d7ce14Thanks @avivkeller! - Avoids directly mutating the AST inlegacy-json, as to ensure future generators do not run with a input different than they expect.