Skip to content

Releases: TypeStrong/typedoc

v0.22.13

06 Mar 21:52
Compare
Choose a tag to compare

Features

  • Add support for TypeScript 4.6, #1877.
  • Support copying @param comments for nested members that target union and intersection types, #1876.

Bug Fixes

  • Fixed validation for --requiredToBeDocumented option, #1872.
  • Fixed missing this parameters in documentation for some functions, #1875.

v0.22.12

20 Feb 03:30
Compare
Choose a tag to compare

Features

  • Added --validation.notDocumented option to warn on items that are not documented, #1817.

Bug Fixes

  • Fixed const variables not properly marked as const, #1866.

Thanks!

v0.22.11

18 Jan 03:21
Compare
Choose a tag to compare

Features

  • ReferenceTypes which reference an external symbol will now include qualifiedName and package in their serialized JSON.
  • Added clickable anchor link for member titles, #1842.
  • Added new cname option for GitHub Pages custom domain support, #1803

Bug Fixes

  • Fixed line height of h1 and h2 elements 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 addUnknownSymbolResolver will 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

25 Nov 00:00
Compare
Choose a tag to compare

Features

  • Added support for TypeScript 4.5, #1798.

Bug Fixes

  • If file exports a symbol both under it's real name and as default, the default export 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/node versions, Gerrit0/typedoc-plugin-missing-exports#5.

v0.22.9

14 Nov 21:36
Compare
Choose a tag to compare

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-theme in 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

07 Nov 00:20
Compare
Choose a tag to compare

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 @category tag 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

25 Oct 01:52
Compare
Choose a tag to compare

Features

  • Added support for GitHub enterprise projects with a githubprivate.com domain, #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 hideGenerator is set, #1749.
  • Fixed @category tag 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

17 Oct 17:11
Compare
Choose a tag to compare

Features

  • Added support for displaying identifiers & property access expressions in initializers, #1730.
  • Expanded support for variables tagged with @enum to 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 const style enums, #1727.
  • Fixed handling of @typeParam on 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

02 Oct 17:28
Compare
Choose a tag to compare

Features

  • TypeDoc will now recognize @param comments for destructured parameters and rename __namedParameters to the name specified
    in the @param comment if the number of @param comments match the number of parameters, resolves #1703.
  • The intentionallyNotExported option may now include file names/paths to limit its scope, for example, the following
    will suppress warnings from Foo in src/foo.ts not being exported, but will not suppress warnings if another Foo
    declared in src/utils/foo.ts is not exported.
    {
        "intentionallyNotExported": ["src/foo.ts:Foo"]
    }
  • The --emit option can now be used to more finely control what TypeDoc will emit.
    Value Behavior
    both Emit both documentation and JS.
    docs Emit documentation, but not JS (default).
    none Emit nothing, just convert and run validation.
    true Alias for both, for backwards compatibility. Will be removed in 0.23.
    false Alias 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 @example tags, resolves #1679.
  • TypeScript's emitDeclarationOnly compiler 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 globalThis namespace, could only be caused by a plugin.

Thanks!

v0.22.4

18 Sep 19:10
Compare
Choose a tag to compare

Features

  • Flag option types like validation can now be set to true/false to enable/disable all flags within them.
  • Source code links now work with Bitbucket repositories, resolves #1615.
  • Added githubPages option (default: true), which will create a .nojekyll page in the generated output, resolves #1680.
  • MarkdownEvent is 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.

Thanks!