Changelog

1.0.5 (2024-08-08)

Patch Changes

Fix missing sidebar children for categories

1.0.4 (2024-07-22)

Patch Changes

Fix base sidebar ids in windows (#657)

1.0.3 (2024-07-10)

Patch Changes

Correctly handle sidebar ids with custom docs paths (#648)

1.0.2 (2024-07-01)

Patch Changes

Create output directory if it doesn't exist (#641)

1.0.1 (2024-05-07)

Patch Changes

Handle windows path separators when generating sidebar ids

1.0.0 (2024-05-03)

v1 is a major release that includes a number of improvements.

Architectural Changes

typedoc-plugin-markdown must be updated to V4.
category.yml files are no longer written.
Frontmatter is no longer included by default.

Breaking Changes

Sidebar Configuration

A manual sidebar file should be referenced in sidebars.js rather than autogenerated configuration as previously recommended.

Options Changes

includeExtension has been removed as this behaviour is now the default.
frontmatter option has been removed. Please use typedoc-plugin-frontmatter.
sidebar options position and categoryLabel are no longer relevant and have been removed.

Bug Fixes

Correctly handle sidebar ids in Windows (#597).
Provide exit code on process error (#583)
Use correct path separator in sidebar urls (#489)
Fail docusaurus build when TypeDoc errors - can be overridden with skipErrorChecking (#429).

Earlier changelog entries can be found in CHANGELOG_ARCHIVE.md.