Changelog

4.0.0 (2024-05-03)

v4 is a major release that includes a number of bug fixes, new features and UI improvements.

Architectural Changes

• Handlebars as a dependency has been removed.
• Updated customization model with the ability to set hooks, events and custom theming.
• Exposed navigation structure.

Features

• Updated output file structure.
• Improved and cleaner UI.
• A set of updated and additional new options with comprehensive documentation.
• Exported option types and JSON schema.

Structural Changes

• Each module member is now output to its own file by default. See option --outputFileStrategy. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the option membersWithOwnFile option.
• Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use option --parametersFormat=table.

Breaking Changes

• Because the file structure has changed you may need to update any cross references to files in your documentation.
• Setting theme to "markdown" is no longer required and should be removed.
• The option indexTitle has been removed. Please use the "title.indexPage" key with option --textContentMappings.
• The option allReflectionsHaveOwnDocument has been removed (this behaviour is now the default). Please see option outputFileStrategy.
• The option entryDocument has been renamed to entryFileName to better reflect its purpose.
• The option namedAnchors has been renamed to useHTMLAnchors to better reflect its purpose.
• The option hideInPageTOC has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using typedoc-plugin-remark and the remark-toc plugin.
• The option objectLiteralTypeDeclarationStyle has been removed. Please use option --typeDeclarationFormat=list.

Bug Fixes

• Duplication in callback/callable/function properties. (#581).
• @experimental / @internal annotations. (#556)
• Fix events output and strike-through deprecated items. (#534)
• Class static functions are no longer marked. (#533)
• @example block not rendered with Headline (#501)
• Support for categories (#499)
• Correctly resolve packge readme urls from member pages. (#483)
• Add the ability to add a separate frontmatter for readme file. (#469)
• Items in tables are not linkable. (#463)
• Custom i18n texts. (#458)
• How to improve the formatting for types?. (#456)
• How to change title format. (#450)
• Export Docusaurus plugin options type. (#440)
• How to export interface as a table. (#403)
• Broken Link caused by Typescript class being defined in an index file. (#402)
• Markdown plugin inserts unnecessary escape characters. (#398)
• Potential bug with optional function argument. (#396)
• Respect monorepo readmeFile configuration (#383)
• Embed all objects under a Module/Namespace onto single page. (#338)
• Extra spaces when merging lines in a table. (#331)
• Does not support namespace (or module) and interface with same name. (#300)
• Integration with VitePress? (#287)
• Typedoc comments with text wrapped in < and > breaks Docusaurus Markdown parser. (#276)
• Navigation support? (#262)
• Sidebar Category Support? (#213)
• Properties as Table like function properties. (#109)
• Provide a link/excerpt/screenshot to a demo/example rendered output (#102)

• Prevent escaping of angle brackets in toc (#495)

Features

• Support MDXv2

• TypeDoc 0.25.0 compatibility fixes

Fixes

• Split out comment summary and tags for signatures (#451) .

Features

• TypdeDoc 0.24 compatibility fixes.

Features

• Add objectLiteralTypeDeclarationStyle option (#362)
• Beautify parameter table output of destructured params (#364)

Fixes

• Fix missing descriptions for function params (#357)
• Add conditional check to signature comments (#368)

Fixes

• Replace deprecated 'attemptExternalResolution' (#344)

Fixes

• Export media and includes options (#340)

Fixes

Support @typeParam comments (#326 )

Fixes

• Correctly display accessors in type declaration (#320)
• Add new line after tags (#324)
• Expose values to enums (#323)

Features

• TypeDoc 0.23 compatibility fixes (f39318e)

0.17.4 (2022-04-21)

Note: Version bump only for package docusaurus-plugin-typedoc

3.12.1 (2022-04-21)

Bug Fixes

• Handle non-unique anchor ids (update) (#303) (2deb7b7)

3.12.0 (2022-04-09)

Bug Fixes

• Handle non-unique anchor ids (#303) (787748f)

Features

• Expose preserveAnchorCasing option (#301) (f51ff45)

0.17.2 (2022-03-05)

• Allow option cleanOutputDir (#296)

0.17.0 (2022-02-18)

Features

• Added ability to pass in additional global Frontmatter options (55cc7e0)
• Added new includeExtension option (#293)

3.11.14 (2022-02-14)

Bug Fixes

• wrap index signature output within back ticks (#292) (2226322)

0.16.9 (2022-02-05)

Bug Fixes

• resolve broken links issue (ec2610e)

3.11.13 (2022-02-05)

Bug Fixes

• escape pipes in comments and expand object type in props table (#286) (b87c250)