You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
Exposed additional placeholders in pageTitleTemplates and 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.
This release continues the effort to further align to TypeDoc’s default theme, with improvements that make the plugin more consistent and predictable.
Architectural Changes
Introduced support for TypeDoc core routers. This allows output files to be generated in the same structure as the default HTML theme, while still using the plugin’s Markdown theme.
Exported routers to the public API, enabling customization by other plugins.
Structural Changes
Package readme's (when "entryPointStrategy" is "packages") are now merged with the package index page producing a single entrypoint for packages with an associated readme.
This aligns with the default theme and improves navigation.
To support core routers, a "Hierarchy Summary" page has been introduced to all routers. This feature is turned off by default but can be enabled by setting "includeHierarchySummary" to "true".
When "includeHierarchySummary" is "true", symbols with an available hierarchy now include an associated "Hierarchy" Markdown heading with a "View Summary" link as per the default theme.
Class constructor headings now read "Constructor". This aligns to the TypeDoc internal reflection name and fixes issues with internal anchoring not resolving correctly.
Minor Changes
Implemented support for consuming TypeDoc core routers.
Exported routers to public api.
Implemented a hierarchy summary page as per default theme.
Updated "Constructor" titles of classes to fix internal anchor issues.
Patch Changes
Fix incompatibility when used with "outputs" (#788).
Utilize "anchorPrefix" option to ensure unique anchors linking if required (#764).
This release introduces support for TypeDoc 0.28 that contains several under-the-hood breaking API changes.
From a consumer perspective there should be no direct breaking change from the plugin itself, but there are some architectural and output structure changes to consider.
Architectural Changes
This plugin now utilizes TypeDoc's router feature. This implementation replaces the now deprecated "outputFileStrategy" option. "outputFileStrategy" is still supported for now, but will now point to the "member" and "module" router keys respectively. Further details are contained in the documentation website.
Please note that separate strategies for output generation in different packages (when entryPointStrategy=packages) is no longer possible with this new architecture.
Structural Changes
As per TypeDoc model updates, Object literal Type Alias members are now rendered in groups ("Properties", "Methods") etc rather than under a single "Type Declaration" heading.
A new option "typeAliasPropertiesFormat" has been exposed to place properties rendered from the updated structure to a table format.
Type parameter list views have been updated to separate items with markdown headings for consistency and to improve readability when parameters have detailed explanations or complex properties. If type parameters are straightforward and few in number switching to parametersFormat=table might be preferable.
Minor Changes
Implemented custom routers for plugin to support TypeDoc 0.28 router implementation.
Added "typeAliasPropertiesFormat" option to support TypeDoc 0.28 updated behaviour for Object literal type alias types.
Patch Changes
Mark object properties as optional in PluginOptions interface (#777).
This release introduces structural enhancements to the user interface and bug fixes to enhance overall functionality.
Structural Changes
Source file links are now placed inline rather than under separate "Defined in" headings. This change aligns with the default HTML theme, generates more compact output, and improves the readability of automatically generated Table of Contents (TOCs).
Extraneous "Index" headings on module landing pages have been removed, bringing the structure in line with the default HTML theme and reducing unnecessary clutter.
Anchor IDs are now applied to linkable symbols within table rows by default. Previously, the useHTMLAnchors option was required, but since there is no alternative way to link to these items, this behaviour is now the default.
Minor Changes
Expose "isDeprecated" flag to navigation model (#747).
Moved source link inline and exposed to all parent symbols (#746).
Remove extraneous "Index" headings.
Always assign HTML anchor ids to linkable symbols within table rows.
Patch Changes
Always display inline object for tuple types (#745).
Strikeout deprecated items in reflection indexes.
Fix inline formatting of types when when "useCodeBlocks" is used (#742).
Expose group descriptions to module indexes.
Expose global documents with "packages" entryPointStrategy.
There are two TypeDoc breaking changes that might effect users of this plugin:
TypeDoc has converted to ESM and therefore all public and local CommonJs plugins will need to be refactored to ESM.
TypeScript <5.0 is no longer supported.
Structural Changes
Parameters list views have been updated to separate items with markdown headings to improve readability when parameters have detailed explanations examples, or sub-properties. If parameters are straightforward and few in number switching to parametersFormat=table might be preferable.
Improved structure of curried and overloaded signatures.
Page headings have been simplified to simply display project title as per default theme.
New Features
Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of Markdown if Prettier is installed on a project.
Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#703).
Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#715).
Patch Changes
Improved structure of curried and overloaded signatures (#714) (#718)
The "hideGroupHeadings" option respects group order (#716)
Theme support for TypeDoc’s 0.26 localization model.
Theme support for TypeDoc’s 0.26 documents implementation.
Exposed a new key "htmlTable" to formatting options enabling block elements to render as intended inside table cells. Affects all existing formatting options. Fixes (#618).
Added new formatting options --classPropertiesFormat, --interfacePropertiesFormat and --propertyMembersFormat to further control formatting of different declaration structures.
Supports the ability to control what table columns are rendered with the --tableColumnSettings option.
Patch Changes
Handle duplicate files when tagged in same group (#625)
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.
New 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](/docs/options#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.
The option objectLiteralTypeDeclarationStyle has been removed. Please use option --typeDeclarationFormat=list.
Bug Fixes
Duplication in callback/callable/function properties. (#581).
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.36
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.37
Dec 16, 2023
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.37
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.38
Dec 18, 2023
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.38
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.39
Jan 5, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.39
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.40
Jan 12, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.40
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.41
Jan 18, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.41
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.42
Jan 18, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.42
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.43
Jan 19, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.43
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.44
Jan 30, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.51
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.52
Feb 8, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.52
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.53
Feb 8, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.53
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.54
Mar 21, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.54
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.55
Apr 5, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.55
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.56
Apr 19, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.56
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.57
Apr 21, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.57
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.58
Apr 21, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.58
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.59
Apr 28, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.59
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.60
Apr 29, 2024
renovatebot
changed the title
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.60
chore(deps): update dependency typedoc-plugin-markdown to v4.0.0
May 3, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dependenciesPull requests that update a dependency file
0 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
4.0.0-next.25→4.10.0Release Notes
typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)
v4.10.0Compare Source
Minor Changes
Patch Changes
v4.9.0Compare Source
Minor Changes
navigationJsonthat can be used to write navigation structure as JSON to disk.Patch Changes
v4.8.1Compare Source
Patch Changes
v4.8.0Compare Source
Minor Changes
pageTitleTemplatesand adjusted default templates (#831).strikeDeprecatedPageTitlesoption.Patch Changes
v4.7.1Compare Source
Patch Changes
v4.7.0Compare Source
Minor Changes
useCustomAnchorsandcustomAnchorsFormatoptions - thanks @ocavue.Patch Changes
v4.6.4Compare Source
Patch Changes
@group/@​category=none) (#815).v4.6.3Compare Source
Patch Changes
v4.6.2Compare Source
Patch Changes
@group none,@category noneand@disableGroups.v4.6.1Compare Source
Patch Changes
v4.6.0Compare Source
This release continues the effort to further align to TypeDoc’s default theme, with improvements that make the plugin more consistent and predictable.
Architectural Changes
Structural Changes
This aligns with the default theme and improves navigation.
Minor Changes
Patch Changes
v4.5.2Compare Source
Patch Changes
v4.5.1Compare Source
Patch Changes
v4.5.0Compare Source
This release introduces support for TypeDoc 0.28 that contains several under-the-hood breaking API changes.
From a consumer perspective there should be no direct breaking change from the plugin itself, but there are some architectural and output structure changes to consider.
Architectural Changes
"outputFileStrategy"option."outputFileStrategy"is still supported for now, but will now point to the "member" and "module" router keys respectively. Further details are contained in the documentation website.Structural Changes
typeAliasPropertiesFormat" has been exposed to place properties rendered from the updated structure to a table format.parametersFormat=tablemight be preferable.Minor Changes
Patch Changes
v4.4.2Compare Source
Patch Changes
v4.4.1Compare Source
Patch Changes
v4.4.0Compare Source
This release introduces structural enhancements to the user interface and bug fixes to enhance overall functionality.
Structural Changes
Minor Changes
Patch Changes
v4.3.3Compare Source
Patch Changes
v4.3.2Compare Source
Patch Changes
{@​link}resolution on type alias properties (#732).@linktags.v4.3.1Compare Source
Patch Changes
v4.3.0Compare Source
This release introduces support for TypeDoc 0.27 and some additional UX features and improvements in addition to some bug fixes.
Architectural Changes
Please see the full TypeDoc changelog for additional information.
There are two TypeDoc breaking changes that might effect users of this plugin:
Structural Changes
parametersFormat=tablemight be preferable.New Features
Patch Changes
v4.2.10Compare Source
Patch Changes
v4.2.9Compare Source
Patch Changes
@returnblock tags on declarations (#694)v4.2.8Compare Source
Patch Changes
v4.2.7Compare Source
Patch Changes
v4.2.6Compare Source
Patch Changes
v4.2.5Compare Source
Patch Changes
<thead>and<tbody>elements to fix MDX compatibility issues (#671)v4.2.4Compare Source
Patch Changes
v4.2.3Compare Source
Patch Changes
v4.2.2Compare Source
Patch Changes
v4.2.1Compare Source
Patch Changes
v4.2.0Compare Source
Minor Changes
.nojekyllfile if TypeDocs "githubPages" option is true (#650)v4.1.2Compare Source
Patch Changes
v4.1.1Compare Source
Patch Changes
v4.1.0Compare Source
New Features
Patch Changes
v4.0.3Compare Source
Patch Changes
v4.0.2Compare Source
Patch Changes
v4.0.1Compare Source
Patch Changes
@exampletags on same reflection.v4.0.0Compare Source
Architectural Changes
New Features
Structural Changes
--outputFileStrategy. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the optionmembersWithOwnFileoption.--parametersFormat=table.Breaking Changes
themeto"markdown"is no longer required and should be removed.indexTitlehas been removed. Please use the"title.indexPage"key with option--textContentMappings.allReflectionsHaveOwnDocumenthas been removed (this behaviour is now the default). Please see optionoutputFileStrategy](/docs/options#outputfilestrategy).entryDocumenthas been renamed toentryFileNameto better reflect its purpose.namedAnchorshas been renamed touseHTMLAnchorsto better reflect its purpose.hideInPageTOChas been removed. In-page TOC are no longer included by default.objectLiteralTypeDeclarationStylehas been removed. Please use option--typeDeclarationFormat=list.Bug Fixes
readmeFileconfiguration (#383)<and>breaks Docusaurus Markdown parser. (#276)v4.0.0-next.60Compare Source
v4.0.0-next.59Compare Source
v4.0.0-next.58Compare Source
v4.0.0-next.57Compare Source
v4.0.0-next.56Compare Source
v4.0.0-next.55Compare Source
v4.0.0-next.54Compare Source
v4.0.0-next.53Compare Source
v4.0.0-next.52Compare Source
v4.0.0-next.51Compare Source
v4.0.0-next.50Compare Source
v4.0.0-next.49Compare Source
v4.0.0-next.48Compare Source
v4.0.0-next.47Compare Source
v4.0.0-next.46Compare Source
v4.0.0-next.45Compare Source
v4.0.0-next.44Compare Source
v4.0.0-next.43Compare Source
v4.0.0-next.42Compare Source
v4.0.0-next.41Compare Source
v4.0.0-next.40Compare Source
v4.0.0-next.39Compare Source
v4.0.0-next.38Compare Source
v4.0.0-next.37Compare Source
v4.0.0-next.36Compare Source
v4.0.0-next.35Compare Source
v4.0.0-next.34Compare Source
v4.0.0-next.33Compare Source
v4.0.0-next.32Compare Source
v4.0.0-next.31Compare Source
v4.0.0-next.30Compare Source
v4.0.0-next.29Compare Source
v4.0.0-next.28Compare Source
v4.0.0-next.27Compare Source
v4.0.0-next.26Compare Source
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.