Releases: typedoc2md/typedoc-plugin-markdown
Releases · typedoc2md/typedoc-plugin-markdown
typedoc-plugin-markdown@4.11.0
Minor Changes
- Improved rendering of union types when documented type details are present (#857).
- Improved rendering of union types used in parameter declarations.
- When a function returns another function, full documentation for the returned function is now only shown when meaningful comments are present, aligning with the default theme.
- Index signature declarations are now rendered as blockquotes for improved consistency.
Patch Changes
- Added locale translations for grouped
@exampleheadings (#858). - Function-typed properties are now rendered without parentheses in headings. This avoids implying that the member is a method and more accurately reflects that it is a property whose type is a function.
- Optional properties are now indicated with ? in the property name, making the optionality explicit.
- All pipe characters (
|) in union type output are now escaped.
typedoc-plugin-markdown@4.10.0
Minor Changes
- A JSON schema to be consumed by typedoc.json is now published to the package root.
- Mark parameters with default values as optional, matching the default TypeDoc theme.
Patch Changes
- Fixed markdownlint errors related to empty table cells and invalid link fragments.
- Anchors inside table cells (when property formats equal "table") are now namespaced by reflection kind (for example property-foo) to prevent collisions with Markdown heading slugs and ensure stable in-page links (#856).
- Resolve "does not have an anchor but one was requested" warnings in verbose log mode (#850).
- Guard against undefined types causing errors in complex types in tables (thanks @ilyabo).
typedoc-plugin-markdown@4.9.0
Minor Changes
- Exposed new option
navigationJsonthat can be used to write navigation structure as JSON to disk.
Patch Changes
- Remove type params from inline reflection titles when router=module to resolve anchoring issues (#843).
typedoc-plugin-markdown@4.8.1
Patch Changes
- Correctly handle empty markdown links (#836).
typedoc-plugin-markdown@4.8.0
Minor Changes
- Exposed additional placeholders in
pageTitleTemplatesand adjusted default templates ([#831]). - Tweaked the format of abstract class page titles to include the translated abstract keyword (e.g., "Abstract Class: MyClass") for improved readability.
- Added
strikeDeprecatedPageTitlesoption.
Patch Changes
- Fix incorrect link fragments (#832).
typedoc-plugin-markdown@4.7.1
Patch Changes
- Escape square brackets in index signature types (#829).
- Fix missing segments in declaration titles that contain periods.
typedoc-plugin-markdown@4.7.0
typedoc-plugin-markdown@4.6.4
Patch Changes
- Added theme translations for "de" locale.
- Fix navigation items without group or categories (
@group/@category=none) (#815). - Correctly handle sidebar groups for packages with merged modules.