Skip to content

CHANGELOG.md

Latest commit

 

History

History
137 lines (81 loc) · 14.3 KB

CHANGELOG.md

File metadata and controls

137 lines (81 loc) · 14.3 KB
Raw

@doc-kit/generator-react

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

  • #1104 932ca57 Thanks @btea! - Avoid rendering empty label segments and ensure repeated label segments use unique keys.

  • #1101 a2c0c60 Thanks @ryzrr! - fix(section-pages): re-target type annotation links on chunk pages

  • Updated dependencies [615aabe]:

    • @doc-kit/core@1.2.1

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]:

    • @doc-kit/core@1.0.1

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