Improved support for --entryPointStrategy Packages. TypeDoc will now load package-specific configurations from package.jsontypedoc field. This configuration allows configuring a custom display name (typedoc.displayName) field, entry point (typedoc.entryPoint - this is equivalent and will override typedocMain), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile), #1658.
The --includeVersion option will now be respected by --entryPointStrategy Packages. Also, for this combination, missing version field in the root package.json will not issue a warning.
The navigation partial will now call the new settings, primaryNavigation, and secondaryNavigation partials, #1987.
Bug Fixes
All warnings will be reported instead of only the first warning of a given type, #1981.
Include references will no longer be incorrectly parsed as links, #1986.
The generated schema.json on the website will now use enum values rather than enum names if possible.
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.
Improved support for --entryPointStrategy Packages. TypeDoc will now load package-specific configurations from package.jsontypedoc field. This configuration allows configuring a custom display name (typedoc.displayName) field, entry point (typedoc.entryPoint - this is equivalent and will override typedocMain), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile), #1658.
The --includeVersion option will now be respected by --entryPointStrategy Packages. Also, for this combination, missing version field in the root package.json will not issue a warning.
The navigation partial will now call the new settings, primaryNavigation, and secondaryNavigation partials, #1987.
Bug Fixes
All warnings will be reported instead of only the first warning of a given type, #1981.
Include references will no longer be incorrectly parsed as links, #1986.
The generated schema.json on the website will now use enum values rather than enum names if possible.
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.
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)
dependabot[bot]
commented
2 years ago
Bumps typedoc from 0.22.17 to 0.23.6.
Release notes
Sourced from typedoc's releases.
... (truncated)
Changelog
Sourced from typedoc's changelog.
... (truncated)
Commits
5060fe2Update changelog for releasec09ff78Bump version to 0.23.659a33dePartials: settings, primaryNavigation, secondaryNavigationd9de9f7Update changelog3dfb539Do not attempt to resolve includes as links83a2735Improve support for--entryPointStrategy Packages(#1977)1004768fixes for schema.json (#1983)fdd8238Consider location when checking warning uniqueness9750e2eUpdate changelog for releaseb90fab4Bump version to 0.23.5Dependabot 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)