Releases: TypeStrong/typedoc
Releases Β· TypeStrong/typedoc
v0.22.13
v0.22.12
v0.22.11
Features
ReferenceTypes which reference an external symbol will now includequalifiedNameandpackagein their serialized JSON.- Added clickable anchor link for member titles, #1842.
- Added new
cnameoption for GitHub Pages custom domain support, #1803
Bug Fixes
- Fixed line height of
h1andh2elements being too low, #1796. - Code blocks in the light theme will no longer have the same background as the rest of the page, #1836.
- Symbol names passed to
addUnknownSymbolResolverwill now be correctly given the qualified name to the symbol being referenced, #1832. - The search index will now be written as JSON, reducing load times for large projects, #1825.
Thanks!
v0.22.10
Features
- Added support for TypeScript 4.5, #1798.
Bug Fixes
- If file exports a symbol both under it's real name and as
default, thedefaultexport will now always be the renamed symbol, #1795. - TypeDoc will no longer crash if a symbol is defined both as a normal class (and optional interface) and as a property, as is used for global Node types in older
@types/nodeversions, Gerrit0/typedoc-plugin-missing-exports#5.
v0.22.9
Features
- TypeDoc will now detect and warn if multiple instances of the package are loaded. This usually means that a plugin has its own version of TypeDoc installed, which will lead to things breaking in unexpected ways.
It will only work if both loaded TypeDocs are v0.22.9 or later. - TypeDoc will now automatically load packages with
typedoc-themein their keywords.
Plugins which define a custom theme should include this keyword so that they can be automatically collected and displayed at https://typedoc.org/guides/themes/.
Bug Fixes
- Corrected HTML generation for projects using Google Analytics, #1786.
- Ensured that the
<meta charset="utf-8" />appears within the first 1024 bytes of generated pages, #1783.
Thanks!
v0.22.8
Features
- Added hooks which can be used to inject HTML without completely replacing a template, #1773.
See the documentation in custom-themes.md for details.
Bug Fixes
- Actually fixed
@categorytag incorrectly appearing on function types if used on a type alias, #1745. - Fix error in console when a page contains no documentation items.
Thanks!
v0.22.7
Features
- Added support for GitHub enterprise projects with a
githubprivate.comdomain, #1743. - Added support for GitLab repositories, #1728.
Bug Fixes
- Replaced O(n^2) with O(1) implementation for determining unique IDs in a rendered page, #1755.
- Fixed crash with when running in very large repositories, #1744.
- Fixed visible gap after footer in dark mode if
hideGeneratoris set, #1749. - Fixed
@categorytag incorrectly appearing on function types if used on a type alias, #1745. - Fixed incorrect JS to apply themes on page load, #1709 (again).
- Accessors and index signatures are now properly marked as inherited on declaration creation, #1742.
Thanks!
v0.22.6
Features
- Added support for displaying identifiers & property access expressions in initializers, #1730.
- Expanded support for variables tagged with
@enumto all variables whose property types are string literals, #1740.
Bug Fixes
- Fixed flash when navigating to a second page when OS theme does not match selected theme, #1709.
- Fixed improper quoting of
as conststyle enums, #1727. - Fixed handling of
@typeParamon type aliases, #1733. - Fixed handling of comment tags on function type aliases, #1734.
- Paths in warnings about non-exported symbols are now consistently displayed across platforms, #1738.
Thanks!
v0.22.5
Features
- TypeDoc will now recognize
@paramcomments for destructured parameters and rename__namedParametersto the name specified
in the@paramcomment if the number of@paramcomments match the number of parameters, resolves #1703. - The
intentionallyNotExportedoption may now include file names/paths to limit its scope, for example, the following
will suppress warnings fromFooinsrc/foo.tsnot being exported, but will not suppress warnings if anotherFoo
declared insrc/utils/foo.tsis not exported.{ "intentionallyNotExported": ["src/foo.ts:Foo"] } - The
--emitoption can now be used to more finely control what TypeDoc will emit.Value Behavior bothEmit both documentation and JS. docsEmit documentation, but not JS (default). noneEmit nothing, just convert and run validation. trueAlias for both, for backwards compatibility. Will be removed in 0.23.falseAlias for docs, for backwards compatibility. Will be removed in 0.23.
Bug Fixes
- TypeDoc will now only create one highlighter for rendering code, saving ~200-500ms for rendering time.
- For compatibility with JSDoc, TypeDoc will now strip
<caption>elements from@exampletags, resolves #1679. - TypeScript's
emitDeclarationOnlycompiler option is now supported, resolves #1716. - Fixed discovery of tsconfig.json when the provided path ends in
.json, resolves #1712. - Fixed a crash when converting the
globalThisnamespace, could only be caused by a plugin.
Thanks!
v0.22.4
Features
- Flag option types like
validationcan now be set to true/false to enable/disable all flags within them. - Source code links now work with Bitbucket repositories, resolves #1615.
- Added
githubPagesoption (default: true), which will create a.nojekyllpage in the generated output, resolves #1680. MarkdownEventis now exported, resolves #1696.
Bug Fixes
- Fixed the hamburger menu not being visible on mobile devices, fixes #1699.
- Comments on function implementations with overloaded signatures will now be correctly handled, fixes #1697.