The DEBUG_SEARCH_WEIGHTS global variable can now be set on window to add search scoring information in the search results.
TypeDoc's icons are now available on DefaultThemeRenderContext.icons for use/modification by themes.
v0.23.4
Bug Fixes
TypeDoc no longer ignores project references if --entryPointStrategy Packages is set, #1976.
Boost computations are now done when creating the search index, resulting in a smaller search.js generated file.
Features
The --exclude option will now be respected by --entryPointStrategy Packages and can be used to exclude package directories, #1959.
TypeDoc now emits an IndexEvent on the Renderer when preparing the search index, #1953.
Added new --searchInComments option to include comment text in the search index, #1553.
Turning this option on will increase the size of your search index, potentially by an order of magnitude.
v0.23.3
Bug Fixes
Function properties in type space will no longer be interpreted as methods, #1637.
TypeDoc will no longer crash if a comment contains an empty @example tag, #1967.
TypeDoc will now detect attempted inheritance from accessors and inherit from the getter or setter, #1968.
intentionallyNotExported will now properly respect qualified names, #1972.
Fixed missing namespace comments on export * as NS declarations, #1973.
Fixed missing comments on export const x = () => 123 function variables, #1973.
Exported variable functions with properties will now be converted as a function+namespace instead of a variable+namespace, #1651.
Validation warnings caused by missing documentation will now be formatted like other warnings which reference a declaration.
TypeDoc will no longer warn if both the get and set signatures of an accessor have a comment.
Features
Added --htmlLang option to set the lang attribute in the generated HTML. Defaults to en, #1951.
Added --basePath option to override TypeDoc's detected root directory, #1924.
Added support for TypeDoc specific :getter and :setter meaning keywords in declaration references.
Warnings caused by comment contents will now do a better job of including the location of the text that caused the warning.
v0.23.2
Bug Fixes
Module comments will no longer be inappropriately attached to signatures, #1962.
Projects with a single entry point will now parse @module comments in the entry point, #1963.
Removed duplicate "in comment" warning when parsing comments, #1964.
Reflections with a boost of <= 0 due to searchCategoryBoosts or searchGroupBoosts will be excluded from search.
The DEBUG_SEARCH_WEIGHTS global variable can now be set on window to add search scoring information in the search results.
TypeDoc's icons are now available on DefaultThemeRenderContext.icons for use/modification by themes.
v0.23.4 (2022-07-02)
Bug Fixes
TypeDoc no longer ignores project references if --entryPointStrategy Packages is set, #1976.
Boost computations are now done when creating the search index, resulting in a smaller search.js generated file.
Features
The --exclude option will now be respected by --entryPointStrategy Packages and can be used to exclude package directories, #1959.
TypeDoc now emits an IndexEvent on the Renderer when preparing the search index, #1953.
Added new --searchInComments option to include comment text in the search index, #1553.
Turning this option on will increase the size of your search index, potentially by an order of magnitude.
v0.23.3 (2022-07-01)
Bug Fixes
Function properties in type space will no longer be interpreted as methods, #1637.
TypeDoc will no longer crash if a comment contains an empty @example tag, #1967.
TypeDoc will now detect attempted inheritance from accessors and inherit from the getter or setter, #1968.
intentionallyNotExported will now properly respect qualified names, #1972.
Fixed missing namespace comments on export * as NS declarations, #1973.
Fixed missing comments on export const x = () => 123 function variables, #1973.
Exported variable functions with properties will now be converted as a function+namespace instead of a variable+namespace, #1651.
Validation warnings caused by missing documentation will now be formatted like other warnings which reference a declaration.
TypeDoc will no longer warn if both the get and set signatures of an accessor have a comment.
Features
Added --htmlLang option to set the lang attribute in the generated HTML. Defaults to en, #1951.
Added --basePath option to override TypeDoc's detected root directory, #1924.
Added support for TypeDoc specific :getter and :setter meaning keywords in declaration references.
Warnings caused by comment contents will now do a better job of including the location of the text that caused the warning.
v0.23.2 (2022-06-28)
Bug Fixes
Module comments will no longer be inappropriately attached to signatures, #1962.
Projects with a single entry point will now parse @module comments in the entry point, #1963.
Removed duplicate "in comment" warning when parsing comments, #1964.
Reflections with a boost of <= 0 due to searchCategoryBoosts or searchGroupBoosts will be excluded from search.
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 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 from 0.21.4 to 0.23.5.
Release notes
Sourced from typedoc's releases.
... (truncated)
Changelog
Sourced from typedoc's changelog.
... (truncated)
Commits
9750e2e
Update changelog for releaseb90fab4
Bump version to 0.23.5ed17338
Expose TypeDoc's icons for use by themes9cf85e8
Add support for DEBUG_SEARCH_WEIGHTS7993ce7
Rebuild specs to remove info dependent on git repoecb6e00
Update changelog for release40ad5a1
Release 0.23.4cad213c
Make visual regression a manual jobf172a24
Make search functionality more customizablef66dbd5
Add support for filtering packages with --excludeDependabot 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 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)