Skip to content

Latest commit

 

History

History
165 lines (96 loc) · 17.8 KB

CHANGELOG.md

File metadata and controls

165 lines (96 loc) · 17.8 KB

@doc-kit/generator-react

0.5.3

Patch Changes

  • #1203 0e999db Thanks @helmipradita! - Skip the index entry when building page URLs in the sitemap generator so the index page is only listed once under indexURL.

0.5.2

Patch Changes

  • #1209 68f559f Thanks @avivkeller! - Fall back to PostCSS, rather than Lightning CSS's wasm build, on platforms without native Lightning CSS bindings

0.5.1

Patch Changes

  • #1186 5598f92 Thanks @btea! - Fix template value replacement treating $ sequences (such as $$ in Makefile snippets) as special replacement patterns, which corrupted the rendered output.

  • #1179 b8d7b77 Thanks @ovflowd! - Builds use less memory, most of all with few threads: each worker's young generation is limited to 96MB, a single thread processes one chunk at a time and lets go of the pages' code before rendering them, and Vite's native bundler gets as many threads as doc-kit and returns the memory it frees. On the Node.js API docs, --threads 1 now builds with Node.js's --max-old-space-size=512, and no longer crashes when legacy-html is built alongside other targets.

  • #1190 060be4c Thanks @dbisina! - orama-db.json is now identical between builds of the same docs: documents get a stable href id instead of a time-based one, and are sorted by href.

  • #1178 0321911 Thanks @ovflowd! - Install fewer packages: @doc-kit/core updates cosmiconfig to v10 (TypeScript config files now load through Node's type stripping) and no longer installs dedent, and @doc-kit/generator-react estimates reading time with Intl.Segmenter instead of the reading-time package and updates @node-core/ui-components to 1.8.1, which no longer installs @vcarl/remark-headings.

  • #1196 c9a2cdb Thanks @avivkeller! - Fall back on platforms without native Rolldown or Lightning CSS bindings

  • Updated dependencies [e49eb52, b8d7b77, 92efbbe, 9e21017, 854a944, 0321911]:

0.5.0

Minor Changes

  • #1156 6d5f9d1 Thanks @ovflowd! - Builds take about half the memory and a third of the time (measured on the Node.js API docs): Shiki registers each language once code in it is highlighted, highlighted code reaches pages as static markup rather than a tree per token, all.html is rendered by the worker pool, output is no longer minified by default (serve it compressed instead), idle workers end after 250ms, and each worker's heap is limited to 512MB, which Node.js's --max-old-space-size raises.

  • #1117 d704bbf Thanks @ovflowd! - feat(html): navigate between pages client-side with the Navigation API, prefetching them on hover, keep the search index and remote config in memory across pages, scope speculation rules to links that leave the site, and hash fonts (reported through the bundler's new fonts) so every asset can be cached immutably

  • #1127 c50e75f Thanks @ovflowd! - Add the llms-txt-full generator, writing a llms-full.txt file holding the Markdown of every page, each preceded by its URL.

  • #1157 a4c9684 Thanks @ovflowd! - Add a markdown option to add remark, rehype, and recma plugins to the generators processing Markdown, or configure the ones they use, such as Shiki. The @doc-kit/core modules the generators' pipelines replace are removed (utils/remark.mjs, utils/remark-shiki.mjs, and utils/highlighter.mjs), and utils/type-annotations moves to plugins/type-annotations

Patch Changes

0.4.2

Patch Changes

  • #1106 cf6e157 Thanks @btea! - Render backticks in search result descriptions as inline code

0.4.1

Patch Changes

0.4.0

Minor Changes

  • #1110 8fd0c13 Thanks @avivkeller! - feat(html): fetch the remote config once through a useRemoteConfig hook, and let its versions key replace the build-time version selector entries

Patch Changes

0.3.1

Patch Changes

0.3.0

Minor Changes

Patch Changes

0.2.0

Minor Changes

Patch Changes

  • #1034 2a106f3 Thanks @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 49cb713 Thanks @pmarkert! - Constructors now render their own class as the return type instead of void

  • #1045 4a22c85 Thanks @avivkeller! - Add a <DocumentationIndex /> MDX component that renders the stability overview of every module, backed by a new documentationIndex export on #theme/config (replaces the <!-- DOCUMENTATION_INDEX --> comment)

  • #1023 27a412a Thanks @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 <section> 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.

  • #1036 7670a78 Thanks @avivkeller! - Generate index.html from the input index document instead of a synthetic page

  • #1049 8cc1fd0 Thanks @avivkeller! - Render markdown summaries as markup instead of as their source

  • Updated dependencies [27a412a, 4a22c85, 8cc1fd0]:

0.1.0

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