Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
This means that any projects setting markedOptions needs to be updated to use markdownItOptions.
Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes.
As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
Changed default of --excludePrivate to true.
Renamed --sitemapBaseUrl to --hostedBaseUrl to reflect that it can be used for more than just the sitemap.
Removed deprecated navigation.fullTree option.
Removed --media option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.
Removed --includes option, use the @document tag instead.
Removed --stripYamlFrontmatter option, TypeDoc will always do this now.
Renamed the --htmlLang option to --lang.
Removed the --gaId option for Google Analytics integration and corresponding analytics theme member, #2600.
All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments
were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
not be inherited by signatures of that function, #2521.
API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where Converter.EVENT_CREATE_DECLARATION
was emitted for ProjectReflection in some circumstances.
API: MapOptionDeclaration.mapError has been removed.
API: Deprecated BindOption decorator has been removed.
API: DeclarationReflection.indexSignature has been renamed to DeclarationReflection.indexSignatures.
Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
API: JSONOutput.SignatureReflection.typeParameter has been renamed to typeParameters to match the JS API.
API: DefaultThemeRenderContext.iconsCache has been removed as it is no longer needed.
API: DefaultThemeRenderContext.hook must now be passed context if required by the hook.
Features
Added support for TypeScript 5.5.
Added new --projectDocuments option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.
TypeDoc now has the architecture in place to support localization. No languages besides English
are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
Added support for a packageOptions object which specifies options that should be applied to each entry point when running with --entryPointStrategy packages, #2523.
--hostedBaseUrl will now be used to generate a <link rel="canonical"> element in the project root page, #2550.
Added support for documenting individual elements of a union type, #2585.
Note: This feature is only available on type aliases directly containing unions.
TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, #2581.
New option, --customFooterHtml to add custom HTML to the generated page footer, #2559.
TypeDoc will now copy modifier tags to children if specified in the --cascadedModifierTags option, #2056.
TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both @alpha and @beta), #2056.
Groups and categories can now be collapsed in the page body, #2330.
Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
This means that any projects setting markedOptions needs to be updated to use markdownItOptions.
Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes.
As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
Changed default of --excludePrivate to true.
Renamed --sitemapBaseUrl to --hostedBaseUrl to reflect that it can be used for more than just the sitemap.
Removed deprecated navigation.fullTree option.
Removed --media option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.
Removed --includes option, use the @document tag instead.
Removed --stripYamlFrontmatter option, TypeDoc will always do this now.
Renamed the --htmlLang option to --lang.
Removed the --gaId option for Google Analytics integration and corresponding analytics theme member, #2600.
All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments
were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
not be inherited by signatures of that function, #2521.
API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where Converter.EVENT_CREATE_DECLARATION
was emitted for ProjectReflection in some circumstances.
API: MapOptionDeclaration.mapError has been removed.
API: Deprecated BindOption decorator has been removed.
API: DeclarationReflection.indexSignature has been renamed to DeclarationReflection.indexSignatures.
Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
API: JSONOutput.SignatureReflection.typeParameter has been renamed to typeParameters to match the JS API.
API: DefaultThemeRenderContext.iconsCache has been removed as it is no longer needed.
API: DefaultThemeRenderContext.hook must now be passed context if required by the hook.
Features
Added support for TypeScript 5.5.
Added new --projectDocuments option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.
TypeDoc now has the architecture in place to support localization. No languages besides English
are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
Added support for a packageOptions object which specifies options that should be applied to each entry point when running with --entryPointStrategy packages, #2523.
--hostedBaseUrl will now be used to generate a <link rel="canonical"> element in the project root page, #2550.
Added support for documenting individual elements of a union type, #2585.
Note: This feature is only available on type aliases directly containing unions.
TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, #2581.
New option, --customFooterHtml to add custom HTML to the generated page footer, #2559.
TypeDoc will now copy modifier tags to children if specified in the --cascadedModifierTags option, #2056.
TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both @alpha and @beta), #2056.
Groups and categories can now be collapsed in the page body, #2330.
Bumps the typescript group with 9 updates in the /app directory:
6.12.07.13.16.12.07.13.10.43.10.45.00.2.170.3.010.9.110.9.20.25.30.26.01.1.02.0.03.17.14.0.35.2.25.5.2Updates
@typescript-eslint/eslint-pluginfrom 6.12.0 to 7.13.1Release notes
Sourced from
@typescript-eslint/eslint-plugin's releases.... (truncated)
Changelog
Sourced from
@typescript-eslint/eslint-plugin's changelog.... (truncated)
Commits
1212a8fchore(release): publish 7.13.1af34737docs: improve return-await description about motivation (#9201)bf48dc5fix(eslint-plugin): [no-unsafe-member-access] differentiate a types-error any...33acc50fix(eslint-plugin): [return-await] support explicit resource management (#9044)50ed604fix(eslint-plugin): [prefer-readonly] refine report locations (#8894)8a178edchore(release): publish 7.13.063e53e2chore(deps): update dependency prettier to v3.3.1 (#9308)fb52f78feat(eslint-plugin): [no-dynamic-delete] allow all string literals as index (...ab2916cchore: enable eslint-plugin/no-property-in-node internally (#9261)629035fdocs: mention rule scripts under Local Development (#9258)Updates
@typescript-eslint/parserfrom 6.12.0 to 7.13.1Release notes
Sourced from
@typescript-eslint/parser's releases.... (truncated)
Changelog
Sourced from
@typescript-eslint/parser's changelog.... (truncated)
Commits
1212a8fchore(release): publish 7.13.18a178edchore(release): publish 7.13.0c9a6dd9feat(parser, typescript-estree): export withoutProjectParserOptions utility (...7e93b28chore(release): publish 7.12.02bbf656fix(types): correct typing ParserOptions (#9202)e360541chore(release): publish 7.11.0c18226echore(release): publish 7.10.077fc366chore(release): publish 7.9.0f53fecechore: add knip (#8192)ee677f6chore(release): publish 7.8.0Updates
eslintfrom 8.54.0 to 8.57.0Release notes
Sourced from eslint's releases.
... (truncated)
Changelog
Sourced from eslint's changelog.
... (truncated)
Commits
abea3b68.57.01cd3f8cBuild: changelog update for 8.57.01813aecchore: upgrade@eslint/js@8.57.0 (#18143)5c356bbchore: package.json update for@eslint/jsrelease84922d0docs: Show prerelease version in dropdown (#18139)1120b9bfeat: Add loadESLint() API method for v8 (#18098)5b8c363docs: Switch to Ethical Ads (#18117)2196d97fix: handle absolute file paths inFlatRuleTester(#18064)f4a1fe2test: add more tests for ignoring files and directories (#18068)69dd1d1fix: Ensure config keys are printed for config errors (#18067)Updates
eslint-config-xofrom 0.43.1 to 0.45.0Release notes
Sourced from eslint-config-xo's releases.
Commits
a26a2f60.45.06f2ff13Allow class fields with no blank lines between (#85)b17659e0.44.0f2060deRequire Node.js 1827049c1Enablelogical-assignment-operatorsrule288a3caEnableprefer-object-has-ownruledfa969cBanatobandbtoab31ab8ano-unused-vars: Allow ignoring variables by prefixing with underscore9809e67Meta tweaks3a5448bAddobject-curly-newlinerule (#83)Updates
eslint-plugin-tsdocfrom 0.2.17 to 0.3.0Changelog
Sourced from eslint-plugin-tsdoc's changelog.
Commits
Updates
ts-nodefrom 10.9.1 to 10.9.2Release notes
Sourced from ts-node's releases.
Commits
057ac1b10.9.2c8805d5Update package lock99862f7Bump swc dependencycdc4e88Ignore test files in build schema08cdfb0Backport swc fixes on main9639daaIgnore test files in buildcc1a503Fixtsconfig.jsonnot found with TS >= 5.3 (#2091)Updates
typedocfrom 0.25.3 to 0.26.0Release notes
Sourced from typedoc's releases.
... (truncated)
Changelog
Sourced from typedoc's changelog.
... (truncated)
Commits
222ed1bUpdate changelog for release0b5a179Bump version to 0.26.0a61cdcbRecognize@defaultValueas text in more situations1b55285Remove --gaId option2dde2e9Slightly more docs cleanup6e6b3b6Typed event emitterse35608faddtheme_loadingkey931ca15Merge remote-tracking branch 'origin/master' into beta055e8e0Add missing changelog entry38b0cbfDefault html parsing to true for markdownUpdates
typedoc-github-wiki-themefrom 1.1.0 to 2.0.0Changelog
Sourced from typedoc-github-wiki-theme's changelog.
Commits
346c7cachore(global): updated docsced95cdchore(global): version packages for releaseaa5fd6achore(global): updated docs for releasece8756achore: Updated docs9b49bbbfix: removed deprecated options.38442e4fix: tweaks to link behaviour in page headere320f96Version Packages (next)e431c56chore: Updated docs2f7b078feat: AddedsanitizeCommentsoption.53f8d32Version Packages (next)Updates `typedoc...
Description has been truncated