Releases: TypeStrong/typedoc
Releases · TypeStrong/typedoc
v0.28.13
Features
- The
basePath
option now also affects relative link resolution, TypeDoc will also check for
paths relative to the provided base path. If you instead want TypeDoc to only change the rendered
base path for sources, use thedisplayBasePath
option, #3009.
Bug Fixes
- Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.
@inheritDoc
will now correctly overwrite@remarks
and@returns
blocks on the target comment, #3012.- The
externalSymbolLinkMappings
option now works properly on links pointing to inherited/overwritten signatures, #3014.
v0.28.12
Bug Fixes
- Variables marked with
@enum
now work for symbols imported from another module, #3003. - Improved magic introduced with #2999 to work with imported symbols, #3003.
- Fixed relative link resolution to file names containing percent encoded URLs, #3006.
- Linking to the project's README file with a relative link will now behave as expected, #3006.
- Reduced unnecessary HTML element rendering in default theme.
API:Reflection.hasComment
andComment.hasVisibleComponent
now accepts an optionalnotRenderedTags
parameter.
v0.28.11
Features
- Object properties declared with shorthand property assignment will now use the variable's comment
if they do not have their own comment, #2999.
Bug Fixes
- Fixed link resolution not working correctly in first comment on the file in some cases, #2994.
- Optional methods are now rendered with a trailing
?
in the reflection preview and signature, #2995. - The
compilerOptions
option now functions properly with non-boolean options, #3000. - Configuration errors within the
compilerOptions
option are now handled gracefully, #3000. - Fixed improper casing of "Type Declaration" header, #3002.
v0.28.10
v0.28.9
Features
- Add support for TypeScript 5.9, #2989.
Bug Fixes
- Fixed bug introduced in 0.28.8 where TypeDoc could not render docs when members inherited from a complex type alias, #2982.
- Fixed automatic discovery of entry points when not running in packages mode, #2988.
- Fixed discovery of package.json file when running with entry points containing a glob, #2985.
v0.28.8
Features
- If using JS config files, the
plugin
option can now be given plugin functions to load. - Permit
-
within tag names to supporttypescript-json-schema
's@TJS-type
tag, #2972. - Exposed
Context.createSymbolId
for use by plugins.
Bug Fixes
- Relative links in
<img srcset>
will now be discovered by TypeDoc, #2975. - Relative links in
<source src>
and<source srcset>
elements will now be discovered by TypeDoc, #2975. - Improved inherited from/overwrites link discovery to point to parent properties in more cases, #2978
Thanks!
v0.28.7
Features
- Introduced the
@sortStrategy
tag to override thesort
option on a specific reflection, #2965.
Bug Fixes
- Classes and functions exported with
export { type X }
are no longer missing comments, #2970. - Setting
locale
to an unknown value will now cause TypeDoc to operate in English instead of a debug locale. - Array options will now report an error if set to a non-array/non-string value.
v0.28.6
Features
- TypeDoc now supports resolving relative paths in links to the package directory as belonging to the project, #2961.
- Declarations without comments will now check for comments on their export specifier, #2964.
Bug Fixes
- Attempting to highlight a supported language which is not enabled is now a warning, not an error, #2956.
- Improved compatibility with CommonMark's link parsing, #2959.
- Classes, variables, and functions exported with
export { type X }
are now detected and converted as interfaces/type aliases, #2962. - Improved warning messaging for links to symbols which were resolved, but the symbols were not included in the documentation, #2967.
- Fixed an issue preventing nested documents from being deserialized from TypeDoc's JSON output or used in packages mode, #2969.
Thanks!
v0.28.5
v0.28.4
Features
- The navigation in the default theme will now attempt to break long names onto multiple lines, #2940.
- Added German (de) localization, #2941.
Bug Fixes
- TypeDoc's default theme now uses the same chevron for all collapsible elements, #2924
ThechevronSmall
helper is now deprecated and will be removed with v0.29.0. - Classes/interfaces marked with
@hidden
will no longer appear in the
"Hierarchy" section of the docs. - TypeDoc now handles wildcard JSDoc types, #2949.