typedoc - npm Package Versions

v0.26.11 (2024-11-01)

Features

• If hostedBaseUrl is set to the root page on a website, TypeDoc will now include WebSite structured data, #2760.

Bug Fixes

• Fix support for ESM config files with Node 23, #2752.
• Fix type errors when using "module": "ESNext" and importing TypeDoc, #2747.
• Inherited comments on overloaded methods now consider the overload position when inheriting a comment, #2755.

v0.26.10 (2024-10-16)

Bug Fixes

• Fixed missing space on page headers, #2748.

v0.26.9 (2024-10-11)

Features

• Added headings option to control optional headings, #2729.
• Updated Chinese translations, #2739.
• Added a folder icon to page navigation elements which are not links, #2741.

Bug Fixes

• externalSymbolLinkMappings now uses the TypeScript reported link target if available, #2725.
• TypeDoc will no longer omit the modules page if a project contains only modules/documents, #2730.
• Fixed missing breadcrumbs on project page, #2728.
• TypeDoc will no longer render an empty readme page if no readme was found.

Thanks!

• @lriggle-strib
• @mrfigg
• @XeroAlpha

v0.26.8 (2024-10-04)

Features

• Updated Chinese translations, #2706.
• Exported constants no longer render the type and default value if they are the same, #2717.
• The HTML output now wraps tag blocks with <div> tags and includes the tag name in a class name, #2723.

Bug Fixes

• Correctly handle external link resolver link text when referencing an external symbol, #2700.
• Big integer literals are now supported as default values, #2721.
• Corrected handling of @link tags present in comments at the start of source files.
• The index will now display when a module only contains documents, #2722.
• ReflectionSymbolId.pos no longer references the position before any doc comments for a symbol. This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.

Thanks!

• @Corso02
• @lriggle-strib
• @XeroAlpha

v0.26.7 (2024-09-09)

Features

• Support TypeScript 5.6, #2699.
• Added customJs option to include a script tag in generated HTML output, #2650.
• Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #2679.
• Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #2685.
• Added support for the @abstract tag, #2692.

Bug Fixes

• Fixed an issue where links in packages mode would be resolved incorrectly, #2680.
• @link tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.
• Fixed handling of @param tags on comments attached to function callback parameters, #2683.
• The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #2684.
• Fixed incorrect placement of parameter default values in some signatures with a this parameter, #2698.

Thanks!

• @Aryakoste
• @waynemwashuma

v0.26.6 (2024-08-18)

Features

• Use of the @extends block tag no longer produces warnings, #2659. This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
• Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.

Bug Fixes

• The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #2647.
• Restored re-exports in the page navigation menu, #2671.
• JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod#6.
• In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.

v0.26.5 (2024-07-21)

Features

• TypeDoc now exposes array option defaults under OptionDefaults, #2640.

Bug Fixes

• Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #2636.
• Packages mode will now attempt to use the comment declared in the comment class for inherited members, #2622.
• TypeDoc no longer crashes when @document includes an empty file, #2638.
• API: Event listeners added later with the same priority will be called later, #2643.

Thanks!

• @bladerunner2020

v0.26.4 (2024-07-10)

Bug Fixes

• The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names #2625.
• Page navigation now ensures the current page is visible when the page is first loaded, #2626.
• If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #2627.
• @link tags will now be validated in referenced markdown documents, #2629.
• @link tags are now resolved in project documents, #2629.
• HTML/JSON output generated by TypeDoc now contains a trailing newline, #2632.
• TypeDoc now correctly handles markdown documents with CRLF line endings, #2628.
• @hidden is now properly applied when placed in a function implementation comment, #2634.
• Comments on re-exports are now rendered.

Thanks!

• @bukowa
• @garrett-hopper

v0.26.3 (2024-06-28)

Features

• "On This Page" navigation now includes the page groups in collapsible sections, #2616.

Bug Fixes

• mailto: links are no longer incorrectly recognized as relative paths, #2613.
• Added @since to the default list of recognized tags, #2614.
• Relative paths to directories will no longer cause the directory to be copied into the media directory, #2617.