Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from
parsing comments in declaration files, #2611.
Improved comment discovery to more closely match TypeScript's discovery when getting comments
for members of interfaces/classes, #2084, #2545.
Bug Fixes
The text non-highlighted language no longer causes warnings when rendering, #2610.
If a comment on a method is inherited from a parent class, and the child class does not
use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.
Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
This means that any projects setting markedOptions needs to be updated to use markdownItOptions.
Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes.
As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from
parsing comments in declaration files, #2611.
Improved comment discovery to more closely match TypeScript's discovery when getting comments
for members of interfaces/classes, #2084, #2545.
Bug Fixes
The text non-highlighted language no longer causes warnings when rendering, #2610.
If a comment on a method is inherited from a parent class, and the child class does not
use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.
Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
This means that any projects setting markedOptions needs to be updated to use markdownItOptions.
Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes.
As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
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)
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)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps typedoc and typedoc-plugin-markdown. These dependencies needed to be updated together. Updates
typedoc
from 0.25.13 to 0.26.2Release notes
Sourced from typedoc's releases.
... (truncated)
Changelog
Sourced from typedoc's changelog.
... (truncated)
Commits
e5ba1e8
Update changelog for releasef20ec83
Bump version to 0.26.25890d73
Fix actions16b2694
Update comment discovery to more closely match TS42a1759
Add a test for #2545657eb4b
Add suppressCommentWarningsInDeclarationFiles option8ebd7db
Correctly handletext
when highlighting3595873
Update changelog for release81fb64d
Bump version to 0.26.16ef1053
Fix even more packages bugsUpdates
typedoc-plugin-markdown
from 4.0.3 to 4.1.0Release notes
Sourced from typedoc-plugin-markdown's releases.
Changelog
Sourced from typedoc-plugin-markdown's changelog.
Commits
abb5272
Version Packages8575ce8
chore(core): updated packagesc08cc3f
chore(docs): documentation updates9b92507
fix(core): improve Chinese translations7559500
chore(docs): docs update77cf5bf
chore(core): code documentation updates212ec76
feat(core): split out propertiesFormat for classes and interfaces482d5a1
fix(core): added translations for 'jp' and 'zh'e06b849
fix(core): fix reflection flags9b00dca
chore(docs): documentation updatesDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show