[ { "path": ".config/mocha.fast.json", "content": "{\n \"$schema\": \"https://json.schemastore.org/mocharc.json\",\n \"exclude\": [\"src/test/packages/**\", \"src/test/slow/**\"],\n \"extension\": [\"ts\", \"cts\", \"mts\", \"tsx\"],\n \"spec\": [\"src/test/**/*.test.ts\", \"src/test/**/*.test.tsx\"],\n \"timeout\": 5000,\n \"watch-files\": [\"src/**/*.ts\", \"src/**/*.tsx\"],\n \"node-option\": [\"import=tsx\", \"conditions=typedoc-ts\"]\n}\n" }, { "path": ".config/mocha.full.json", "content": "{\n \"$schema\": \"https://json.schemastore.org/mocharc.json\",\n \"timeout\": 0,\n \"spec\": [\"src/test/**/*.test.ts\", \"src/test/**/*.test.tsx\"],\n \"exclude\": [\"src/test/packages/**\"],\n \"node-option\": [\"import=tsx\", \"conditions=typedoc-ts\"]\n}\n" }, { "path": ".config/mocha.test-explorer.json", "content": "{\n \"$schema\": \"https://json.schemastore.org/mocharc.json\",\n \"extension\": [\"ts\"],\n \"ignore\": [],\n \"package\": \"./package.json\",\n \"node-option\": [\"import=tsx\", \"conditions=typedoc-ts\"],\n \"slow\": 500,\n \"spec\": [\"src/**/*.test.ts\", \"src/**/*.test.tsx\"],\n \"timeout\": 0,\n \"watch-files\": [\"src/**/*.ts\", \"src/**/*.tsx\"]\n}\n" }, { "path": ".config/regconfig.json", "content": "{\n \"core\": {\n \"workingDir\": \"dist/tmp/.reg\",\n \"actualDir\": \"dist/tmp/__screenshots__\",\n \"thresholdRate\": 0.001,\n \"addIgnore\": true,\n \"ximgdiff\": {\n \"invocationType\": \"client\"\n }\n }\n}\n" }, { "path": ".config/typedoc.json", "content": "{\n \"$schema\": \"https://typedoc.org/schema.json\",\n \"intentionallyNotExported\": [\n \"SORT_STRATEGIES\",\n \"_ModelToObject\",\n \"EventHooksMomento\",\n \"MarkedPlugin\",\n \"MeaningKeywords\"\n ],\n \"sort\": [\n \"kind\",\n \"instance-first\",\n \"required-first\",\n \"alphabetical-ignoring-documents\"\n ],\n \"name\": \"TypeDoc API\",\n\n // Don't document the debug entry point\n \"entryPoints\": [\"../src/index.ts\"],\n \"outputs\": [\n {\n \"name\": \"html\",\n \"path\": \"../docs\"\n },\n {\n \"name\": \"json\",\n \"path\": \"../docs/docs.json\"\n }\n ],\n\n \"excludeExternals\": true,\n \"externalPattern\": [\"**/node_modules/**\", \"../src/lib/types/**\"],\n \"excludeInternal\": false,\n \"excludePrivate\": true,\n // \"excludeReferences\": true,\n \"groupReferencesByType\": true,\n \"jsDocCompatibility\": false,\n \"treatWarningsAsErrors\": false,\n \"categorizeByGroup\": false,\n \"categoryOrder\": [\"Reflections\", \"Types\", \"Comments\", \"*\"],\n \"groupOrder\": [\"Common\", \"Namespaces\", \"*\"],\n \"hostedBaseUrl\": \"https://typedoc.org/example/\",\n \"navigationLinks\": {\n \"Docs\": \"https://typedoc.org\",\n \"Example\": \"https://typedoc.org/example/index.html\",\n \"GitHub\": \"https://github.com/TypeStrong/typedoc\"\n },\n \"validation\": {\n \"notExported\": true,\n \"invalidLink\": true,\n \"notDocumented\": false\n },\n \"visibilityFilters\": {\n \"protected\": false,\n \"private\": false,\n \"inherited\": true,\n \"external\": false,\n \"@internal\": false\n },\n \"searchInComments\": true,\n \"searchInDocuments\": true,\n \"searchGroupBoosts\": {\n \"Classes\": 5.0,\n \"Interfaces\": 2.0,\n \"Enumerations\": 2.0,\n \"Type Aliases\": 2.0\n },\n \"navigation\": {\n \"includeCategories\": true,\n \"includeGroups\": false,\n \"excludeReferences\": true\n },\n \"includeVersion\": true,\n \"logLevel\": \"Verbose\",\n \"externalSymbolLinkMappings\": {\n \"@types/markdown-it\": {\n \"MarkdownIt\": \"https://markdown-it.github.io/markdown-it/#MarkdownIt\"\n }\n },\n\n // Saves a couple seconds when generating docs\n \"skipErrorChecking\": true\n}\n" }, { "path": ".editorconfig", "content": "# https://editorconfig.org\n\nroot = true\n\n[*]\ncharset = utf-8\nindent_style = space\nindent_size = 4\nend_of_line = lf\ninsert_final_newline = true\ntrim_trailing_whitespace = true\n\n[package.json]\nindent_size = 2\n\n[src/test/converter2/issues/gh2631/crlf.md]\nend_of_line = crlf\n" }, { "path": ".gitattributes", "content": "# Disable core.autocrlf's line ending conversion behavior to prevent test failures on Windows\n* text=auto eol=lf\nsrc/test/converter2/issues/gh2631/crlf.md text=auto eol=crlf\n\n*.png binary\n*.psd binary\n" }, { "path": ".github/CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n- Demonstrating empathy and kindness toward other people\n- Being respectful of differing opinions, viewpoints, and experiences\n- Giving and gracefully accepting constructive feedback\n- Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n- Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n- The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n- Trolling, insulting or derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or email\n address, without their explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\ntypedoc@gerritbirkeland.com.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\n[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].\n\nCommunity Impact Guidelines were inspired by\n[Mozilla's code of conduct enforcement ladder][mozilla coc].\n\nFor answers to common questions about this code of conduct, see the FAQ at\n[https://www.contributor-covenant.org/faq][faq]. Translations are available\nat [https://www.contributor-covenant.org/translations][translations].\n\n[homepage]: https://www.contributor-covenant.org\n[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html\n[mozilla coc]: https://github.com/mozilla/diversity\n[faq]: https://www.contributor-covenant.org/faq\n[translations]: https://www.contributor-covenant.org/translations\n" }, { "path": ".github/CONTRIBUTING.md", "content": "# Contributing to TypeDoc\n\nThanks for taking the time to contribute! TypeDoc is a volunteer-run project and we couldn't do it without your help.\n\nThis document includes a set of guidelines for contributing to TypeDoc. These are guidelines, not rules. If something seems off, please feel free to propose changes to this document in a pull request.\n\n## Table of Contents\n\n- [Contributing to TypeDoc](#contributing-to-typedoc)\n - [Table of Contents](#table-of-contents)\n - [How Can I Contribute?](#how-can-i-contribute)\n - [Bug Reports](#bug-reports)\n - [Suggestions](#suggestions)\n - [Documentation](#documentation)\n - [Code](#code)\n - [Setup - Git, GitHub, and Node](#setup---git-github-and-node)\n - [Installation](#installation)\n - [Linting, Building, and Testing](#linting-building-and-testing)\n - [Linting](#linting)\n - [Building](#building)\n - [Testing](#testing)\n - [Pull Requests](#pull-requests)\n - [Updating Your Branch](#updating-your-branch)\n\n## How Can I Contribute?\n\n### Bug Reports\n\nThis section guides you through submitting a bug report for TypeDoc. Following these guidelines helps others understand your report and resolve the issue.\n\nBefore creating a bug report please check [this list][bugs] to see if it has already been reported. If the issue is closed, please open a new issue and link it to the original issue.\n\nWhen creating a bug report, explain the problem and include as much additional information as necessary to help maintainers to reproduce it. Ideally, provide an example project which highlights the problem.\n\n- **Use a clear and descriptive title** for the issue to identify the problem\n- **Describe your project setup**. The easier it is for maintainers to reproduce your problem, the more likely it is to be quickly fixed.\n- **Explain what you expected to see instead and why**\n\n### Suggestions\n\nThis section guides you through submitting an enhancement suggestion for Typedoc.\n\nBefore creating a feature request, please check [this list][suggestions] to see if it has already been requested.\n\nWhen creating an enhancement request, explain your use case and ultimate goal. This will make it possible for contributors to suggest existing alternatives which may already meet your requirements.\n\n- **Use a clear and descriptive title** for the issue to identify the suggestion.\n- **Provide an example where this enhancement would improve TypeDoc**\n- **If possible, list another documentation generator where this feature exists**\n\n### Documentation\n\nTypeDoc is documented in 4 primary areas.\n\n- This repo's [README.md](https://github.com/TypeStrong/typedoc/blob/master/README.md)\n- The website guides hosted at [TypeStrong/typedoc-site](https://github.com/TypeStrong/typedoc-site/)\n- Doc comments of source files which are rendered in the [api docs](https://typedoc.org/api/)\n- The [option descriptions](https://github.com/TypeStrong/typedoc/blob/ce0654295698e2bb2badf5f93d388bd977da3c46/src/lib/application.ts#L66) used by the `--help` command\n\nIf you would like to improve the documentation in any of these areas, please open an issue if there isn't one already to discuss what you would like to improve. Then submit a [Pull Request](#pull-requests) to this repo, (or to [TypeStrong/typedoc-site](https://github.com/TypeStrong/typedoc-site/) in the case of guides).\n\n### Code\n\nUnsure of where to begin contributing to TypeDoc? You can start by looking through the issues labeled [good-first-issue] and [help-wanted]. Issues labeled with [good-first-issue] should only require changing a few lines of code and a test or two. Issues labeled with [help-wanted] can be considerably more involved and may require changing multiple files.\n\nFor instructions on setting up your environment, see the [setup](#setup---git-github-and-node) instructions in this document.\nOnce set up, you may find the [development](https://typedoc.org/guides/development/) page useful for an overview of TypeDoc's architecture.\n\nIf you have started work on an issue and get stuck or want a second opinion on your implementation feel free to reach out through [Discord].\n\n## Setup - Git, GitHub, and Node\n\nIf you don't already have [Git] installed, install it first. You will need it to contribute to TypeDoc. You will also need to install [Node] and pnpm.\n\n#### Installation\n\n1. Fork the TypeDoc repository - https://github.com/TypeStrong/typedoc/fork\n1. Open a terminal, or \"Git Bash\" on Windows.\n1. Use `cd` to move to the directory that you want to work in.\n1. Clone your repository, replace USER with your GitHub username:\n ```bash\n git clone https://github.com/USER/typedoc\n ```\n1. Add the TypeDoc repo as a remote repository\n ```bash\n git remote add typedoc https://github.com/TypeStrong/typedoc\n ```\n1. Install dependencies:\n ```bash\n pnpm install\n ```\n1. Build:\n ```bash\n pnpm build\n ```\n1. Open the typedoc folder in your favorite editor. If you don't have one, try [Visual Studio Code][vscode]\n\n## Linting, Building, and Testing\n\nOnce you have cloned TypeDoc, you can lint, build, and test the code from your terminal.\n\n#### Linting\n\nTo lint the TypeDoc code, run `pnpm run lint`. This will start eslint and check all files for stylistic problems. You can also install an eslint plugin for your editor to show most style problems as you type.\n\nYou can automatically fix some style problems by running `pnpx dprint fmt`.\n\n#### Building\n\nTo compile the TypeDoc source, run `pnpm build`. This will start the TypeScript compiler and output the compiled JavaScript to the `dist` folder.\n\n#### Testing\n\nTypeDoc includes an extensive set of tests that describe its output. To validate any changes you have made run `pnpm test`.\nThis will run a subset of TypeDoc's tests intended for quick development checks.\nTests which take more than half a second are located in `src/test/slow`, and will only be run if you run `pnpm run test:full`.\n\nIf you have changed the TypeDoc output, it will cause tests to fail. Once you have validated that the introduced changes were intended, run `pnpm run rebuild_specs` to update the spec files for the new output.\n\nAdditional tests are contained within the `converter2` directory that look for specific issues with previous\nbuilds and may be more appropriate for adding a test for a bugfix.\n\n#### Visual Regression Testing\n\nThere is also a script to visually compare the differences between changes. To set this up, build the code, then run `node scripts/visual_regression.js`. This will create a baseline which future runs will be compared against after making changes, compiling, and running the visual regression script again.\n\n## Pull Requests\n\nOnce you have finished working on an issue, you can submit a pull request to have your changes merged into the TypeDoc repository and included in the next release.\n\nBefore submitting a pull request, make sure that there are no linting problems (`pnpm run lint`), all tests pass (`pnpm test`), and your branch is up to date. Its also a good idea to join the TypeScript [discord] and visit the `#typedoc` channel to discuss how best to implement changes.\n\nIf your change is user facing, consider updating `CHANGELOG.md` to describe the change you have made. If you don't, the maintainer who merges your pull request will do it for you.\n\nPlease do not change the project version number in a pull request unless submitting a patch to the `lts` branch.\n\n## Updating Your Branch\n\nIf the TypeDoc repository has changed since you originally forked it, you will need to update your repository with the latest changes before submitting a pull request. To pull the latest changes from the TypeDoc repo, run `git pull typedoc master`.\n\n[bugs]: https://github.com/TypeStrong/typedoc/labels/bug\n[suggestions]: https://github.com/TypeStrong/typedoc/labels/enhancement\n[good-first-issue]: https://github.com/TypeStrong/typedoc/labels/good%20first%20issue\n[help-wanted]: https://github.com/TypeStrong/typedoc/labels/help%20wanted\n[discord]: https://discord.com/invite/typescript\n[github]: https://github.com\n[git]: https://git-scm.com\n[node]: https://nodejs.org/en/\n[vscode]: https://code.visualstudio.com/\n" }, { "path": ".github/FUNDING.yml", "content": "github: gerrit0\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug Report\nabout: Report a bug in TypeDoc\ntype: Bug\n---\n\n## Search terms\n\n\n\n## Expected Behavior\n\n\n\n## Actual Behavior\n\n\n\n## Steps to reproduce the bug\n\n\n\n## Environment\n\n- TypeDoc version:\n- TypeScript version:\n- Node.js version:\n- OS:\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "contact_links:\n - name: Discussions\n url: https://github.com/TypeStrong/typedoc/discussions\n about: Please ask questions here.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature Request\nabout: Suggest improvements or new features\ntype: Feature\n---\n\n## Search Terms\n\n\n\n## Problem\n\n\n\n## Suggested Solution\n\n\n" }, { "path": ".github/SECURITY.md", "content": "# Security Policy\n\n## Supported Versions\n\nThe TypeDoc team supports the latest minor version. For one minor version prior to the latest,\npull requests providing patches to fix security vulnerabilities will be accepted. Support for the\nprevious minor version relies completely on community pull requests.\n\nSee https://typedoc.org/documents/Overview.html for the current status.\n\n## Patching LTS Versions\n\nIf you depend on the prior minor version of TypeDoc and want to submit a fix, submit a pull request\nto the `lts` branch. When merged, a new version will be automatically published with your patch.\n\nBe sure to include an update to the version field in `package.json`.\n\nNote: Only pull requests which fix security vulnerabilities will be accepted. Additional features and bug fixes are out of scope for old versions.\n" }, { "path": ".github/workflows/build-site.yml", "content": "name: Build Site\non:\n push:\n pull_request:\n schedule:\n - cron: \"0 5 * * *\"\njobs:\n build:\n runs-on: ubuntu-latest\n name: Build Site\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - name: Set up Node\n uses: actions/setup-node@v4\n with:\n node-version: 20\n - name: Set up pnpm\n run: npm i -g pnpm@10\n - name: Install\n run: pnpm install\n - name: Build\n run: pnpm run build\n - name: Build Site\n run: ./scripts/build_site.sh\n - name: Upload static files as artifact\n id: deployment\n uses: actions/upload-pages-artifact@v3\n with:\n path: docs-site/\n deploy:\n needs: build\n if: github.ref == 'refs/heads/master'\n name: Deploy\n permissions:\n pages: write\n id-token: write\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n\n runs-on: ubuntu-latest\n steps:\n - name: Deploy to GitHub Pages\n id: deployment\n uses: actions/deploy-pages@v4\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\non: [push, pull_request]\njobs:\n build:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node: [\"18\", \"20\", \"22.4.1\", \"23\"]\n name: Node ${{ matrix.node }}\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n - name: Set up Node\n uses: actions/setup-node@v4\n with:\n node-version: ${{ matrix.node }}\n - name: Set up pnpm\n run: npm i -g pnpm@10\n - name: Install\n run: pnpm install\n - name: Build\n run: pnpm run build\n - name: Test\n run: |\n if node -e \"process.exit(Number(+process.versions.node.slice(0, 2) < 23))\"; then\n export NODE_OPTIONS=\"--no-experimental-strip-types\"\n fi\n pnpm run test:full\n - name: Lint\n run: pnpm run lint\n - name: Circular dependency check\n uses: gerrit0/circular-dependency-check@v2.0.2\n with:\n entry: |\n dist/index.js\n dist/lib/models/index.js\n dist/browser-utils.js\n build-release:\n runs-on: ubuntu-latest\n name: Node 22 Release\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n - name: Set up Node\n uses: actions/setup-node@v4\n with:\n node-version: 22.4.1\n - name: Set up pnpm\n run: npm i -g pnpm@10\n - name: Install\n run: pnpm install\n - name: Build\n run: |\n node scripts/set_strict.js false\n pnpm run build\n - name: Test\n run: pnpm run test:full\n - name: Lint\n run: pnpm run lint\n build-windows:\n runs-on: windows-latest\n name: Node 18 Windows\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n - name: Set up Node\n uses: actions/setup-node@v4\n with:\n node-version: 18\n - name: Set up pnpm\n run: npm i -g pnpm@10\n - name: Install\n run: pnpm install\n - name: Build\n run: pnpm run build\n - name: Test\n run: pnpm run test:full\n - name: Lint\n run: pnpm run lint\n" }, { "path": ".github/workflows/publish-beta.yml", "content": "name: Publish Beta\non:\n push:\n branches:\n - beta\njobs:\n npm-publish:\n name: npm-publish\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n - id: check\n uses: EndBug/version-check@v2.1.4\n with:\n diff-search: true\n - name: Set up Node\n if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')\n uses: actions/setup-node@v4\n with:\n node-version: \"18\"\n - name: Setup pnpm\n if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')\n run: npm i -g pnpm@10\n - name: Install\n if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')\n run: pnpm install\n - name: Test\n if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')\n run: pnpm test\n - name: Publish\n if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')\n # We need --no-git-checks because we swap a boolean to allow more lax types\n # in the published package.\n run: pnpm publish --tag beta --no-git-checks\n env:\n npm_config_//registry.npmjs.org/:_authToken: ${{ secrets.NPM_AUTH_TOKEN }}\n" }, { "path": ".github/workflows/publish-lts.yml", "content": "name: Publish LTS\non:\n push:\n branches:\n - lts\njobs:\n npm-publish:\n name: npm-publish\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n - id: check\n uses: EndBug/version-check@v2.1.4\n with:\n diff-search: true\n - name: Set up Node\n if: steps.check.outputs.changed == 'true'\n uses: actions/setup-node@v4\n with:\n node-version: \"18\"\n - name: Set up pnpm\n if: steps.check.outputs.changed == 'true'\n run: npm i -g pnpm@10\n - name: Install\n if: steps.check.outputs.changed == 'true'\n run: pnpm install\n - name: Test\n if: steps.check.outputs.changed == 'true'\n run: pnpm test\n - name: Publish\n if: steps.check.outputs.changed == 'true'\n # We need --no-git-checks because we swap a boolean to allow more lax types\n # in the published package.\n run: pnpm publish --tag lts --no-git-checks\n env:\n npm_config_//registry.npmjs.org/:_authToken: ${{ secrets.NPM_AUTH_TOKEN }}\n" }, { "path": ".github/workflows/publish.yml", "content": "name: Publish\non:\n push:\n branches:\n - master\n\npermissions:\n id-token: write # Required for OIDC\n contents: write # Required for git tag\n\njobs:\n npm-publish:\n name: npm-publish\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - id: check\n uses: EndBug/version-check@v2.1.4\n with:\n diff-search: true\n - name: Set up Node\n if: steps.check.outputs.changed == 'true'\n uses: actions/setup-node@v4\n with:\n node-version: \"24\"\n - name: Set up pnpm\n if: steps.check.outputs.changed == 'true'\n run: npm i -g pnpm@10\n - name: Install\n if: steps.check.outputs.changed == 'true'\n run: pnpm install\n - name: Test\n if: steps.check.outputs.changed == 'true'\n run: pnpm test\n - name: Publish\n if: steps.check.outputs.changed == 'true'\n # We need --no-git-checks because we swap a boolean to allow more lax types\n # in the published package and generate some files for publishing.\n run: pnpm publish --no-git-checks\n - name: Generate Release\n if: steps.check.outputs.changed == 'true'\n run: |\n git config user.email \"typedoc@gerritbirkeland.com\"\n git config user.name \"TypeDoc Bot\"\n node scripts/create_release.js\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".gitignore", "content": ".DS_Store\n.idea\n.vs\n.tscache\n.baseDir.js\n.baseDir.ts\n*.swp\nyarn.lock\n.nyc_output\nyarn-error.log\ntypedoc-config.schema.json\n\n/src/test/renderer/*/doc\n/src/test/renderer/testProject/json.json\n**/node_modules/\n!src/test/converter2/behavior/node_modules/\n!src/test/converter2/renderer/node_modules/\n/coverage/\n/dist/\n/docs\n/docs2\n/docs-*\n/td*.json\n\ntypedoc*.tgz\ntmp\n/*.0x/\n\nsrc/test/renderer/specs/assets/*\nsrc/test/renderer/specs/specs.json\n\n# Built theme JS\nstatic/main.js\n\n/example/docs/\n" }, { "path": ".npmrc", "content": "# If these were only for production, we'd care, but there's no\n# way to ask pnpm to only report production audit findings when doing\n# an install, so just turn it off. We can still check for findings\n# with pnpm audit --production.\naudit = false\n\n# While we're on the TS beta, need this flag.\nlegacy-peer-deps = true\n\n# This breaks some of the scripts in the scripts directory\nupdate-notifier = false\n" }, { "path": ".vscode/extensions.json", "content": "{\n \"recommendations\": [\n \"hbenl.vscode-test-explorer\",\n \"hbenl.vscode-mocha-test-adapter\",\n \"dprint.dprint\"\n ]\n}\n" }, { "path": ".vscode/launch.json", "content": "{\n // Use IntelliSense to learn about possible Node.js debug attributes.\n // Hover to view descriptions of existing attributes.\n // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"args\": [\n \"--import=tsx\",\n \"--timeout\",\n \"0\",\n \"--config\",\n \"${workspaceFolder}/.config/mocha.fast.json\"\n ],\n \"internalConsoleOptions\": \"openOnSessionStart\",\n \"name\": \"Debug Tests\",\n \"program\": \"${workspaceFolder}/node_modules/mocha/bin/mocha.js\",\n \"request\": \"launch\",\n \"skipFiles\": [\"/**\"],\n \"type\": \"node\"\n },\n {\n \"name\": \"Attach\",\n \"port\": 9229,\n \"request\": \"attach\",\n \"internalConsoleOptions\": \"openOnSessionStart\",\n \"skipFiles\": [\"/**\"],\n \"type\": \"node\",\n \"sourceMaps\": true\n }\n ]\n}\n" }, { "path": ".vscode/settings.json", "content": "{\n \"files.associations\": {\n \"tsdoc.json\": \"jsonc\", // TSDoc allows comments.\n \"typedoc.json\": \"jsonc\" // TypeDoc uses the JSONC parser for its configuration files.\n },\n\n \"typescript.tsdk\": \"./node_modules/typescript/lib\",\n \"dprint.path\": \"./node_modules/dprint/dprint\",\n\n // Automatically run the formatter when certain files are saved.\n \"[javascript]\": {\n \"editor.defaultFormatter\": \"dprint.dprint\",\n \"editor.formatOnSave\": true,\n \"editor.tabSize\": 4\n },\n \"[typescript]\": {\n \"editor.defaultFormatter\": \"dprint.dprint\",\n \"editor.formatOnSave\": true,\n \"editor.tabSize\": 4\n },\n \"[typescriptreact]\": {\n \"editor.defaultFormatter\": \"dprint.dprint\",\n \"editor.formatOnSave\": true,\n \"editor.tabSize\": 4\n },\n \"[json]\": {\n \"editor.defaultFormatter\": \"dprint.dprint\",\n \"editor.formatOnSave\": true,\n \"editor.tabSize\": 4\n },\n \"[jsonc]\": {\n \"editor.defaultFormatter\": \"dprint.dprint\",\n \"editor.formatOnSave\": true,\n \"editor.tabSize\": 4\n },\n \"[css]\": {\n \"editor.defaultFormatter\": \"dprint.dprint\",\n \"editor.formatOnSave\": true,\n \"editor.tabSize\": 4\n },\n\n \"mochaExplorer.nodeArgv\": [\"--import=tsx\", \"--conditions=typedoc-ts\"],\n\n \"eslint.workingDirectories\": [\".\", \"./example\"],\n \"mochaExplorer.configFile\": \".config/mocha.test-explorer.json\",\n \"cSpell.ignoreRegExpList\": [\n // Ignore usernames in the Thanks sections of the changelog\n \"/^- +@[A-Z0-9_-]+/igm\",\n // Ignore combined hashes in JSON output for rendering testing\n \"/#[a-z0-9_]+\\\"/\"\n ],\n \"cSpell.words\": [\n \"callouts\",\n \"cname\",\n \"Combinatorially\",\n \"deconfliction\",\n \"deserializers\",\n \"dprint\",\n \"frontmatter\",\n \"githubprivate\",\n \"hideconstructor\",\n \"linkcode\",\n \"linkify\",\n \"linkplain\",\n \"momento\",\n \"Msys\",\n \"nodoc\",\n \"shiki\",\n \"srcset\",\n \"tsbuildinfo\",\n \"tsdoc\",\n \"typedoc\",\n \"typeof\",\n \"typestrong\",\n \"uncategorized\",\n \"WCAG\"\n ]\n}\n" }, { "path": ".vscode/tasks.json", "content": "{\n // See https://go.microsoft.com/fwlink/?LinkId=733558\n // for the documentation about the tasks.json format\n \"version\": \"2.0.0\",\n \"tasks\": [\n {\n \"label\": \"build-tsc\",\n \"type\": \"npm\",\n \"script\": \"build:tsc\",\n \"problemMatcher\": [\"$tsc\"],\n \"detail\": \"Build TypeDoc w/ tsc\",\n \"presentation\": {\n \"group\": \"build\",\n \"panel\": \"dedicated\"\n },\n \"group\": {\n \"kind\": \"build\"\n }\n },\n {\n \"label\": \"build-themes\",\n \"type\": \"npm\",\n \"script\": \"build:themes\",\n \"problemMatcher\": [\"$esbuild\"],\n \"detail\": \"Build TypeDoc themes\",\n \"presentation\": {\n \"group\": \"build\",\n \"panel\": \"dedicated\"\n },\n \"group\": {\n \"kind\": \"build\"\n }\n },\n {\n \"label\": \"dev-build-tsc\",\n \"type\": \"shell\",\n \"command\": \"pnpm build:tsc --watch\",\n \"problemMatcher\": [\"$tsc-watch\"],\n \"detail\": \"Build TypeDoc w/ tsc in watch mode\",\n \"isBackground\": true,\n \"presentation\": {\n \"group\": \"dev\",\n \"panel\": \"dedicated\"\n },\n \"group\": {\n \"kind\": \"build\"\n }\n },\n {\n \"label\": \"dev-build-themes\",\n \"type\": \"shell\",\n \"command\": \"pnpm build:themes --watch\",\n \"problemMatcher\": [\"$esbuild-watch\"],\n \"detail\": \"Build TypeDoc themes in watch mode\",\n \"isBackground\": true,\n \"presentation\": {\n \"group\": \"dev\",\n \"panel\": \"dedicated\"\n },\n \"group\": {\n \"kind\": \"build\"\n }\n },\n {\n \"label\": \"dev\",\n \"dependsOn\": [\"dev-build-tsc\", \"dev-build-themes\"],\n \"detail\": \"Build TypeDoc in watch mode\",\n \"problemMatcher\": [],\n \"group\": {\n \"kind\": \"build\"\n }\n },\n {\n \"label\": \"build\",\n \"dependsOn\": [\"build-tsc\", \"build-themes\"],\n \"detail\": \"Build TypeDoc\",\n \"problemMatcher\": [],\n \"group\": {\n \"kind\": \"build\",\n \"isDefault\": true\n }\n }\n ]\n}\n" }, { "path": "CHANGELOG.md", "content": "---\ntitle: Changelog\n---\n\n## Unreleased\n\n## v0.28.17 (2026-02-13)\n\n### Bug Fixes\n\n- Improved handling of comments for type aliases which have been declaration merged with functions, #3064.\n- Fixed anchor link generation to members named `$`, #3065.\n- Corrected typing of the `plugin` option to permit functions, #3066.\n- Warnings about unused `@param` tags will now be properly suppressed when they come from declaration files and\n the suppressCommentWarningsInDeclarationFiles option is enabled, #3070.\n- Fixed conversion of types referencing type parameters on functions, #3071.\n\n### Thanks!\n\n- @pjeby\n\n## v0.28.16 (2026-01-12)\n\n### Bug Fixes\n\n- Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, #3052.\n- Fixed an issue preventing automatic entry point discovery on Windows, #3057.\n- Improved vertical positioning of text icons, #3056.\n- TypeDoc no longer includes source location information for type literal reflections. This could sometimes\n cause TypeDoc to infer the wrong path when resolving base paths for display.\n- Adjusted markdown rendering to allow `markdownItLoader` to override more rendering #3055.\n\n### Features\n\n- Added support for regions for `@include` in `.tsx`, `.cjs`, and `.mjs` file references #3048.\n- Comments for TS-in-JS `@typedef` tags may now specify modifier tags with the inline tag syntax `{@mod}`.\n This makes it possible to add modifier tags to these members, which previously was not possible as\n TypeScript's parsing stops for these members at the next non-braced tag, #2916 and #3050.\n- A `typedoc-config.schema.json` is now included in the root of the package with a JSON schema for TypeDoc's\n configuration file. The schema for the latest version is also published at https://typedoc.org/schema.json\n and will automatically be picked up when writing typedoc.json files if you are using VSCode, #3054.\n\n### Thanks!\n\n- @a10nik\n- @kozi\n- @Lakuna\n\n## v0.28.15 (2025-11-29)\n\n### Features\n\n- The `gitRevision` option now accepts the special value `{branch}`, which indicates source links should use\n the current git branch for links, #3041.\n- Introduced `validation.invalidPath` for suppressing warnings caused by referencing relative paths which\n do not exist when building the documentation, #3033.\n- API: Introduced `Logger.validationWarning` for validation which occurs during conversion rather than\n during TypeDoc's normal validation step, #3033.\n\n## v0.28.14 (2025-10-11)\n\n### Features\n\n- Introduced the `preservedTypeAnnotationTags` option to specify tags whose type annotations should\n be copied to the output documentation, #3020.\n API: Introduced `typeAnnotation` on `CommentTag`\n- Added `excludePrivateClassFields` option to hide `#private` members while allowing `private` members, #3017.\n- Added support for TypeScript's `@this` tag for JS files which describe `this` parameters, #3026.\n- API: Re-introduced `relevanceBoost` on `DeclarationReflection` for plugin use, #3036.\n\n### Bug Fixes\n\n- Fixed conversion of auto-accessor types on properties with the `accessor` keyword, #3019.\n- Improved handling of HTML tags within headers for anchor generation, #3023.\n- Improved support for detecting destructured parameters and renaming them to the name used in the doc comment, #3026.\n- Constructor type parameters will now inherit their class's type parameter descriptions if not otherwise specified, #3031.\n- Fixed compatibility with `@microsoft/tsdoc-config` version 0.18.0, #3035.\n- Custom theme icons will now be used in the \"On This Page\" sidebar, #3039.\n\n### Thanks!\n\n- @iclanton\n- @jonchardy\n\n## v0.28.13 (2025-09-14)\n\n### Features\n\n- The `basePath` option now also affects relative link resolution, TypeDoc will also check for\n paths relative to the provided base path. If you instead want TypeDoc to only change the rendered\n base path for sources, use the `displayBasePath` option, #3009.\n\n### Bug Fixes\n\n- Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.\n- `@inheritDoc` will now correctly overwrite `@remarks` and `@returns` blocks on the target comment, #3012.\n- The `externalSymbolLinkMappings` option now works properly on links pointing to inherited/overwritten signatures, #3014.\n\n## v0.28.12 (2025-09-01)\n\n### Bug Fixes\n\n- Variables marked with `@enum` now work for symbols imported from another module, #3003.\n- Improved magic introduced with #2999 to work with imported symbols, #3003.\n- Fixed relative link resolution to file names containing percent encoded URLs, #3006.\n- Linking to the project's README file with a relative link will now behave as expected, #3006.\n- Reduced unnecessary HTML element rendering in default theme.\n API: `Reflection.hasComment` and `Comment.hasVisibleComponent` now accepts an optional `notRenderedTags` parameter.\n\n## v0.28.11 (2025-08-25)\n\n### Features\n\n- Object properties declared with shorthand property assignment will now use the variable's comment\n if they do not have their own comment, #2999.\n\n### Bug Fixes\n\n- Fixed link resolution not working correctly in first comment on the file in some cases, #2994.\n- Optional methods are now rendered with a trailing `?` in the reflection preview and signature, #2995.\n- The `compilerOptions` option now functions properly with non-boolean options, #3000.\n- Configuration errors within the `compilerOptions` option are now handled gracefully, #3000.\n- Fixed improper casing of \"Type Declaration\" header, #3002.\n\n## v0.28.10 (2025-08-10)\n\n### Bug Fixes\n\n- Fixed inconsistent anchors on module pages for re-exports, #2990.\n- Markdown references which appear to be footnotes will no longer be checked for links, #2991.\n\n## v0.28.9 (2025-08-01)\n\n### Features\n\n- Add support for TypeScript 5.9, #2989.\n\n### Bug Fixes\n\n- Fixed bug introduced in 0.28.8 where TypeDoc could not render docs when members inherited from a complex type alias, #2982.\n- Fixed automatic discovery of entry points when not running in packages mode, #2988.\n- Fixed discovery of package.json file when running with entry points containing a glob, #2985.\n\n## v0.28.8 (2025-07-28)\n\n### Features\n\n- If using JS config files, the `plugin` function can now be given plugin functions to load.\n- Permit `-` within tag names to support `typescript-json-schema`'s `@TJS-type` tag, #2972.\n- Exposed `Context.createSymbolId` for use by plugins.\n\n### Bug Fixes\n\n- Relative links in `` will now be discovered by TypeDoc, #2975.\n- Relative links in `` and `` elements will now be discovered by TypeDoc, #2975.\n- Improved inherited from/overwrites link discovery to point to parent properties in more cases, #2978\n\n### Thanks!\n\n- @jonathanhefner\n- @laymonage\n\n## v0.28.7 (2025-06-30)\n\n### Features\n\n- Introduced the `@sortStrategy` tag to override the `sort` option on a specific reflection, #2965.\n\n### Bug Fixes\n\n- Classes and functions exported with `export { type X }` are no longer missing comments, #2970.\n- Setting `locale` to an unknown value will now cause TypeDoc to operate in English instead of a debug locale.\n- Array options will now report an error if set to a non-array/non-string value.\n\n## v0.28.6 (2025-06-27)\n\n### Features\n\n- TypeDoc now supports resolving relative paths in links to the package directory as belonging to the project, #2961.\n- Declarations without comments will now check for comments on their export specifier, #2964.\n\n### Bug Fixes\n\n- Attempting to highlight a supported language which is not enabled is now a warning, not an error, #2956.\n- Improved compatibility with CommonMark's link parsing, #2959.\n- Classes, variables, and functions exported with `export { type X }` are now detected and converted as interfaces/type aliases, #2962.\n- Improved warning messaging for links to symbols which were resolved, but the symbols were not included in the documentation, #2967.\n- Fixed an issue preventing nested documents from being deserialized from TypeDoc's JSON output or used in packages mode, #2969.\n\n### Thanks!\n\n- @yGuy\n\n## v0.28.5 (2025-05-26)\n\n### Bug Fixes\n\n- References to type aliases defined as mapped types will now correctly create a reference to the type alias, #2954.\n- `ignoredHighlightLanguages` can now be used to prevent warnings for codeblocks containing languages\n which are supported by Shiki but are not loaded, #2956.\n\n## v0.28.4 (2025-05-04)\n\n### Features\n\n- The navigation in the default theme will now attempt to break long names onto multiple lines, #2940.\n- Added German (de) localization, #2941.\n\n### Bug Fixes\n\n- TypeDoc's default theme now uses the same chevron for all collapsible elements, #2924\n The `chevronSmall` helper is now deprecated and will be removed with v0.29.0.\n- Classes/interfaces marked with `@hidden` will no longer appear in the\n \"Hierarchy\" section of the docs.\n- TypeDoc now handles wildcard JSDoc types, #2949.\n\n### Thanks!\n\n- @blutorange\n- @bkeepers\n\n## v0.28.3 (2025-04-20)\n\n### Bug Fixes\n\n- `@inline` now functions when referencing tuple types, #2932.\n- `@link` links to the current page are now rendered, #2934.\n- `@includeCode` now supports regions in TypeScript files with `.mts` and `.cts` file extensions, #2935.\n- Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, #2937.\n- Improved error reporting when paths including Windows separators are provided as globs, #2938.\n\n## v0.28.2 (2025-04-07)\n\n### Features\n\n- `@group none` and `@category none` will now render their children without a section\n heading in the default theme, #2922.\n- Added `@disableGroups` tag to completely disable the grouping mechanism for a\n given reflection, #2922.\n\n### Bug Fixes\n\n- Variables using `@class` now correctly handle `@category`, #2914.\n- Variables using `@class` now include constructor parameters, #2914.\n- Variables using `@class` with a generic first constructor function now adopt\n that function's type parameters as the class type parameters, #2914.\n- When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, #2918.\n- Inlining types can now handle more type variants, #2920.\n- Fixed behavior of `externalSymbolLinkMappings` option when URL is set to `#`, #2921.\n- Fixed broken links within module pages when structure-dir router was used, #2928.\n- Type parameters on JS classes defined with `@typedef` now correctly handle the constraint, #2929.\n- API: `toString` on types containing index signatures now behave correctly, #2917.\n- Added `@inlineType` to the list of tags excluded by default.\n\n## v0.28.1 (2025-03-20)\n\n### Features\n\n- The `TypeDocOptions` interface now marks options as optional so it no longer has to be wrapped in `Partial`\n for use in config files, #2901.\n- API: Expose control methods for deferred conversion for plugin use (typedoc-plugin-missing-exports)\n- API: Expose method to disable TypeDoc usage of `localStorage` without clearing it, #2908.\n\n### Bug Fixes\n\n- `--watch` can now infer entry points from `package.json` as supported in non-watch mode, #2899.\n- `@include` with regions now works on files with CRLF line endings, #2902.\n- Generated page names now correctly handles UTF-8 characters requiring more than 16 bits #2905.\n- Fixed a crash when converting `module.exports = []`, #2909.\n- Fixed URL generation which introduced a superfluous `./` in relative links, #2910.\n\n### Thanks!\n\n- @jsmith2-coveo\n- @romainmnr\n\n## v0.28.0 (2025-03-15)\n\n### Breaking Changes\n\n- TypeDoc now expects all input globs paths to be specified with `/` path separators, #2825.\n- TypeDoc's `--entryPointStrategy merge` mode now requires JSON from at least version 0.28.0.\n- Removed `jp` translations from `lang`, to migrate switch to `ja`.\n- File name references in `intentionallyNotExported` now use a package name/package relative path instead of an absolute path for matching.\n- The `source-order` sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.\n- TypeDoc will only check for a project README file next to the discovered `package.json` file if `--readme` is not set\n this change improves handling of monorepo setups where some packages have readme files and others do not, #2875.\n- Function-like variable exports will now only be automatically converted as function types if\n they are initialized with a function expression. TypeDoc can be instructed to convert them as functions\n with the `@function` tag, #2881.\n- Object literal type alias types will now be converted in a way which causes them to be rendered more similarly\n to how interfaces are rendered, #2817.\n\n### API Breaking Changes\n\n- `ProjectReflection.getReflectionFromSymbol` and `ProjectReflection.getSymbolFromReflection` have been moved to `Context`\n- `Path` and `PathArray` parameter types now always contain normalized paths.\n- Introduced a `Router` which is used for URL creation. `Reflection.url`,\n `Reflection.anchor`, and `Reflection.hasOwnDocument` have been removed.\n- `Deserializer.reviveProject(s)` no longer accepts an option to add project documents.\n- `Deserializer.reviveProjects` now requires an `alwaysCreateEntryPointModule` option.\n- `Comment.serializeDisplayParts` no longer requires a serializer argument.\n- `ReflectionSymbolId.fileName` is now optional, TypeDoc now stores a combination of a package name and package relative path instead.\n The `fileName` property will be present when initially created, but is not serialized.\n- Removed `DeclarationReflection.relevanceBoost` attribute which was added for plugins, but never used.\n- `i18n` proxy is no longer passed to many functions, instead, reference `i18n` exported from the module directly.\n- `ReflectionKind.singularString` and `ReflectionKind.pluralString` now returns translated strings.\n The methods on `Internationalization` to do this previously have been removed.\n- The HTML output structure for the search box has changed to support the new modal.\n- `DefaultThemeRenderContext`'s `typeDeclaration` and `typeDetailsIfUseful`\n methods now require both a reflection and a type in order to support\n `@expandType`\n\n### Features\n\n- Add support for TypeScript 5.8.x\n- The search modal in the HTML output has been rewritten to provide better mobile support\n- Added a `--router` option which can be used to modify TypeDoc's output folder\n structure. This can be extended with plugins, #2111.\n- Introduced the `@primaryExport` modifier tag to provide more fine grained\n control over export conversion order, #2856\n- Introduced `packagesRequiringDocumentation` option for `validation.notDocumented`, TypeDoc will expect comments to be present for symbols in the specified packages.\n- TypeDoc now exports a `typedoc/browser` entrypoint for parsing and using serialized JSON files, #2528.\n- Type `packageOptions` as `Partial`, #2878.\n- TypeDoc will now warn if an option which should only be set at the root level is set in `packageOptions`, #2878.\n- Introduced `@function` tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.\n- Exposed a `TypeDoc` global object in the HTML theme which can be used to prevent TypeDoc from using `localStorage`, #2872.\n- Introduced `@preventInline` and `@inlineType` tags for further control extending the `@inline` tag, #2862.\n- Introduced `@preventExpand` and `@expandType` tags for further control extending the `@expand` tag, #2862.\n- API: Introduced `DefaultThemeRenderContext.reflectionIcon` for more granular control over displayed reflection icons.\n\n### Bug Fixes\n\n- TypeDoc will now only create references for symbols re-exported from modules.\n- Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #2824.\n- User filter settings will no longer sometimes cause the search to have fewer visible results than expected.\n- Fixed handling of expando functions which were also merged with a namespace, #2876.\n- Fixed rendering of function types within arrays and union types, #2892.\n- Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #2894.\n\n### Thanks!\n\n- @crimx\n- @jsmith2-coveo\n- @phoneticallySAARTHaK\n- @XeroAlpha\n\n## v0.27.9 (2025-02-25)\n\nThis will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.\n\n### Features\n\n- Added support for TypeScript 5.8\n\n## v0.27.8 (2025-02-21)\n\n### Features\n\n- The `visibilityFilter` option now supports individual signatures, #2846.\n- The `favicon` option may now be given a link starting with `https?://` instead of a path, #2851.\n- TypeDoc now supports specifying `#` as the link in `externalSymbolLinkMappings` to indicate the type should not be linked to, #2853.\n\n### Bug Fixes\n\n- Fixed an issue where unrecognized languages would incorrectly be listed in the list of languages with translations, #2852.\n- Unresolved external type references will no longer incorrectly linked to `undefined`, #2854.\n\n### Thanks!\n\n- @pjeby\n- @XeroAlpha\n\n## v0.27.7 (2025-02-09)\n\n### Features\n\n- `@includeCode` and `@inline` can now inject parts of files using region\n names or line numbers, #2816.\n- Introduced `ja` translation options, deprecated `jp` in favor of `ja`, #2843.\n- Improved TypeDoc's `--watch` option to support watching files not caught by\n TypeScript's watch mode, #2675.\n- The `@inline` tag now works in more places for generic types.\n- Visibility filters now consider individual signatures, #2846.\n\n### Bug Fixes\n\n- Fixed an issue where TypeDoc would incorrectly ignore type arguments in references, #2823.\n- Improved narrator support for labeling icons, #2832.\n- Fixed an issue with `@class` incorrectly handling mapped types, #2842.\n- TypeDoc will now consider symbols to be external only if all of their declarations are external\n so that declaration merged members with global symbols can be documented, #2844.\n- Fixed an issue where TypeDoc would constantly rebuild, #2844.\n- Fixed an issue where the dropdown arrow in the index group would not respect the state of the dropdown, #2845.\n\n### Thanks!\n\n- @pjeby\n- @shawninder\n- @tats-u\n- @XeroAlpha\n\n## v0.27.6 (2024-12-26)\n\n### Features\n\n- Added `ignoredHighlightLanguages` option to specify languages which will be\n allowed in code blocks but not highlighted, #2819.\n\n### Bug Fixes\n\n- `@include` and `@includeCode` now work in the readme file, #2814.\n- TypeDoc will now avoid making references to references, #2811.\n- Fixed output specific option specification, #2818.\n- Improved type reference conversion to avoid including defaulted type arguments, #2820.\n- Fixed parsing of declaration references which include a module and a local reference, #2810.\n- Improved link resolution logic to prioritize type alias properties with the\n same symbol over type literal properties within function parameters.\n\n## v0.27.5 (2024-12-14)\n\n### Bug Fixes\n\n- Possibly Breaking: TypeDoc will no longer render anchors within the page for\n deeply nested properties. This only affects links to properties of\n properties of types, which did not have a clickable link exposed so are\n unlikely to have been linked to. Furthermore, these links were not always\n created by TypeDoc, only being created if all parent properties contained\n comments, #2808.\n- TypeDoc will now warn if a property which does not have a URL within the\n rendered document and the parent property/page will be linked to instead,\n #2808. These warnings can be disabled with the `validation.rewrittenLink`\n option.\n- Fix restoration of groups/categories including documents, #2801.\n- Fixed missed relative paths within markdown link references in documents.\n- Improved handling of incomplete inline code blocks within markdown.\n- Direct `https://` links under the `hostedBaseUrl` option's URL will no\n longer be treated as external, #2809.\n\n### Thanks!\n\n- @SacDeNoeuds\n\n## v0.27.4 (2024-12-09)\n\n### Features\n\n- API: Introduced new `Converter.EVENT_CREATE_PROJECT` event which fires when a project is created by the converter, #2800.\n\n### Bug Fixes\n\n- Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.\n- `@include` and `@includeCode` now work for comments on the entry point for projects with a single entry point, #2800.\n- Cascaded modifier tags will no longer be copied into type literals, #2802.\n- `@summary` now works to describe functions within modules, #2803.\n- Corrected navigation showing module link as current when not on module page, #2805.\n\n## v0.27.3 (2024-12-04)\n\n### Features\n\n- Added support for PNG favicons, #2790.\n- Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.\n\n### Bug Fixes\n\n- Add special handling for import types with type errors discarded with ts-expect-error, #2792.\n- Fixed low contrast in default colors for properties/accessors in light mode, #2795.\n- The `highlightLanguages` option now permits Shiki aliases to be specified rather than just the language ID, #2798.\n\n### Thanks!\n\n- @mikalai-snap\n- @mistic100\n\n## v0.27.2 (2024-11-29)\n\n### Bug Fixes\n\n- Fix crash with TypeScript 5.5.x, #2789.\n\n## v0.27.1 (2024-11-28)\n\n### Bug Fixes\n\n- Include classes which inherit from another package in class hierarchy in packages mode, #2467.\n- Fixed handling of `@categoryDescription` and `@groupDescription` on module pages, #2787.\n- Fixed automatic discovery of entry points in packages mode.\n- Reverted accidental style change for hierarchy page introduced in 0.27.0\n- The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.\n\n## v0.27.0 (2024-11-27)\n\n### Breaking Changes\n\n- Convert to ESM to enable easier use of ESM-only dependencies.\n- Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped\n- Relaxed requirements for file names and generated url fragments. This may\n result in a different file name structure, #2714.\n- Anchors to document headings and reflections within a HTML generated pages\n have changed. They can be partially restored to the previous format by\n setting `--sluggerConfiguration.lowercase false`. This change was made to\n more closely match the default behavior of GitHub's markdown rendering and\n VSCode's autocomplete when creating a relative link to an external markdown\n file.\n- Removed the `hideParameterTypesInTitle` option, this was originally added as\n a workaround for many signatures overflowing the available horizontal space\n in rendered pages. TypeDoc now has logic to wrap types/signatures smartly,\n so this option is no longer necessary.\n- Changed the default `kindSortOrder` to put references last.\n- Changed the default `sort` order to use `alphabetical-ignoring-documents`\n instead of `alphabetical`.\n- Changed default of `suppressCommentWarningsInDeclarationFiles` to `true`\n- API: Constructor signatures now use the parent class name as their name\n (e.g. `X`, not `new X`)\n- API: `@group`, `@category`, `@groupDescription` and `@categoryDescription`\n will no longer be removed from the reflections they are present on. They are\n skipped during rendering with the `notRenderedTags` option.\n\n### Features\n\n- Add support for TypeScript 5.7\n- TypeDoc will now discover entry points from `package.json` exports if they\n are not provided manually, #1937.\n- Relative links to markdown files may now include `#anchor` links to\n reference a heading within them.\n- Improved support for `@param` comments with nested object types, #2555.\n- Improved support for `@param` comments which reference a type\n alias/interface. Important properties on the referenced type can now be\n highlighted with `@param options.foo`, which will result in the additional\n note being included under the documentation for that parameter, #2147. Note:\n This feature is limited to references. It is not supported on other types of\n types.\n- Added a new `outputs` option which is an array of outputs. This can be used\n to render the documentation multiple times with different rendering options\n or output types, #2597.\n- Added support for rendering alerts (or callouts) in markdown.\n- Add support for an `@expand` tag which can be placed on type aliases and\n interfaces. When a type with `@expand` is referenced and TypeDoc has a place\n to include additional details about the type, the properties of the type\n will be included in the page where `@expand` is found. Note that use of this\n tag can _significantly_ increase the size of your generated documentation if\n it is applied to commonly used types as it will result in inlining the\n comments for those types everywhere they are referenced, #2303.\n- Add support for an `@inline` tag which can be placed on type aliases and\n interfaces. When a type with `@inline` is referenced, TypeDoc will resolve\n the referenced type and convert the type as if it was included directly\n within the referencing type. Note that use of this tag can _significantly_\n increase the size of your generated documentation if it is applied to\n commonly used types as it will result in inlining the comments for those\n types everywhere they are referenced, #2303.\n- Introduced a new `@useDeclaredType` tag for type aliases which can sometimes\n improve their documentation, #2654.\n- Added a new `@mergeModuleWith` tag which can be used to tell TypeDoc to\n place a module/namespace's children under a different module/namespace and\n remove the real parent, #2281.\n- Added new `@include` and `@includeCode` inline tags to include files within\n comments/documents.\n- Add `notRenderedTags` option. This option is similar to the `excludeTags`\n option, but while `excludeTags` will result in the tag being completely\n removed from the documentation, `notRenderedTags` only prevents it from\n being included when rendering.\n- Added `groupReferencesByType` option.\n- Added `navigation.excludeReferences` option\n- Added `useFirstParagraphOfCommentAsSummary` option to configure how TypeDoc\n handles comments for module members without the `@summary` tag.\n- Introduced `favicon` option to specify a `.ico` or `.svg` favicon to reference.\n- Sections within the page and in the \"On This Page\" navigation are now tied\n together and will expand/collapse together, #2335.\n- API: Introduced a new `app.outputs` object for defining new output strategies.\n- API: TypeDoc's CSS is now wrapped in `@layer typedoc`, #2782.\n\n### Bug Fixes\n\n- TypeDoc now properly flags `readonly` index signatures.\n- TypeDoc will now use the first signature's comment for later signatures in\n overloads if present, #2718.\n- Fixed handling of `@enum` if the type was declared before the variable, #2719.\n- Fixed empty top level modules page in packages mode, #2753.\n- TypeDoc can now link to type alias properties, #2524.\n- TypeDoc will now document the merged symbol type when considering globals\n declared inside `declare global`, #2774\n- TypeDoc now converts `declare module \"foo\"` as a module rather than a namespace, #2778.\n- Import types in type aliases now use module member references if present, #2779.\n- Fixed an issue where properties were not properly marked optional in some\n cases. This primarily affected destructured parameters.\n- Added `yaml` to the highlight languages supported by default.\n- TypeDoc now recognizes `txt` as an alias of `text` to indicate a code block\n should not be highlighted.\n- Items which are hidden with `@ignore` or `@hidden` but still referenced by\n other types will no longer produce warnings about not being exported.\n- If a project only has one module within it, TypeDoc will now consider that\n module when resolving `@link` tags.\n- The arrows to indicate whether or not a section is open now work when\n JavaScript is disabled.\n- Group/category search boosts are now applied when writing the search index\n rather than when converting. This prevents issues where boosts used by just\n one package were incorrectly reported as unused when running with\n entryPointStrategy set to packages.\n\n### Thanks!\n\n- @Huxpro\n- @mrfigg\n- @tgreyuk\n- @XeroAlpha\n\n## v0.26.11 (2024-11-01)\n\n### Features\n\n- If `hostedBaseUrl` is set to the root page on a website, TypeDoc will now include `WebSite` structured data, #2760.\n\n### Bug Fixes\n\n- Fix support for ESM config files with Node 23, #2752.\n- Fix type errors when using `\"module\": \"ESNext\"` and importing TypeDoc, #2747.\n- Inherited comments on overloaded methods now consider the overload position when inheriting a comment, #2755.\n\n## v0.26.10 (2024-10-16)\n\n### Bug Fixes\n\n- Fixed missing space on page headers, #2748.\n\n## v0.26.9 (2024-10-11)\n\n### Features\n\n- Added `headings` option to control optional headings, #2729.\n- Updated Chinese translations, #2739.\n- Added a folder icon to page navigation elements which are not links, #2741.\n\n### Bug Fixes\n\n- `externalSymbolLinkMappings` now uses the TypeScript reported link target if available, #2725.\n- TypeDoc will no longer omit the modules page if a project contains only modules/documents, #2730.\n- Fixed missing breadcrumbs on project page, #2728.\n- TypeDoc will no longer render an empty readme page if no readme was found.\n\n### Thanks!\n\n- @lriggle-strib\n- @mrfigg\n- @XeroAlpha\n\n## v0.26.8 (2024-10-04)\n\n### Features\n\n- Updated Chinese translations, #2706.\n- Exported constants no longer render the type and default value if they are the same, #2717.\n- The HTML output now wraps tag blocks with `
` tags and includes the tag name in a class name, #2723.\n\n### Bug Fixes\n\n- Correctly handle external link resolver link text when referencing an external symbol, #2700.\n- Big integer literals are now supported as default values, #2721.\n- Corrected handling of `@link` tags present in comments at the start of source files.\n- The index will now display when a module only contains documents, #2722.\n- `ReflectionSymbolId.pos` no longer references the position _before_ any doc comments for a symbol.\n This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.\n\n### Thanks!\n\n- @Corso02\n- @lriggle-strib\n- @XeroAlpha\n\n## v0.26.7 (2024-09-09)\n\n### Features\n\n- Support TypeScript 5.6, #2699.\n- Added `customJs` option to include a script tag in generated HTML output, #2650.\n- Added `markdownLinkExternal` option to treat `http[s]://` links in markdown documents and comments as external to be opened in a new tab, #2679.\n- Added `navigation.excludeReferences` option to prevent re-exports from appearing in the left hand navigation, #2685.\n- Added support for the `@abstract` tag, #2692.\n\n### Bug Fixes\n\n- Fixed an issue where links in packages mode would be resolved incorrectly, #2680.\n- `@link` tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.\n- Fixed handling of `@param` tags on comments attached to function callback parameters, #2683.\n- The `alphabetical` and `alphabetical-ignoring-documents` sort options now use `localeCompare` to sort, #2684.\n- Fixed incorrect placement of parameter default values in some signatures with a `this` parameter, #2698.\n\n### Thanks!\n\n- @Aryakoste\n- @waynemwashuma\n\n## v0.26.6 (2024-08-18)\n\n### Features\n\n- Use of the `@extends` block tag no longer produces warnings, #2659.\n 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.\n- Added new `navigation.compactFolders` option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.\n\n### Bug Fixes\n\n- The `suppressCommentWarningsInDeclarationFiles` option now correctly ignores warnings in `.d.cts` and `.d.mts` files, #2647.\n- Restored re-exports in the page navigation menu, #2671.\n- JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod#6.\n- 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.\n\n## v0.26.5 (2024-07-21)\n\n### Features\n\n- TypeDoc now exposes array option defaults under `OptionDefaults`, #2640.\n\n### Bug Fixes\n\n- Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #2636.\n- Packages mode will now attempt to use the comment declared in the comment class for inherited members, #2622.\n- TypeDoc no longer crashes when `@document` includes an empty file, #2638.\n- API: Event listeners added later with the same priority will be called later, #2643.\n\n### Thanks!\n\n- @bladerunner2020\n\n## v0.26.4 (2024-07-10)\n\n### Bug Fixes\n\n- The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names #2625.\n- Page navigation now ensures the current page is visible when the page is first loaded, #2626.\n- If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #2627.\n- `@link` tags will now be validated in referenced markdown documents, #2629.\n- `@link` tags are now resolved in project documents, #2629.\n- HTML/JSON output generated by TypeDoc now contains a trailing newline, #2632.\n- TypeDoc now correctly handles markdown documents with CRLF line endings, #2628.\n- `@hidden` is now properly applied when placed in a function implementation comment, #2634.\n- Comments on re-exports are now rendered.\n\n### Thanks!\n\n- @bukowa\n- @garrett-hopper\n\n## v0.26.3 (2024-06-28)\n\n### Features\n\n- \"On This Page\" navigation now includes the page groups in collapsible sections, #2616.\n\n### Bug Fixes\n\n- `mailto:` links are no longer incorrectly recognized as relative paths, #2613.\n- Added `@since` to the default list of recognized tags, #2614.\n- Relative paths to directories will no longer cause the directory to be copied into the media directory, #2617.\n\n## v0.26.2 (2024-06-24)\n\n### Features\n\n- Added a `--suppressCommentWarningsInDeclarationFiles` option to disable warnings from\n parsing comments in declaration files, #2611.\n- Improved comment discovery to more closely match TypeScript's discovery when getting comments\n for members of interfaces/classes, #2084, #2545.\n\n### Bug Fixes\n\n- The `text` non-highlighted language no longer causes warnings when rendering, #2610.\n- If a comment on a method is inherited from a parent class, and the child class does not\n use an `@param` tag from the parent, TypeDoc will no longer warn about the `@param` tag.\n\n## v0.26.1 (2024-06-22)\n\n### Features\n\n- Improved Korean translation coverage, #2602.\n\n### Bug Fixes\n\n- Added `@author` to the default list of recognized tags, #2603.\n- Anchor links are no longer incorrectly checked for relative paths, #2604.\n- Fixed an issue where line numbers reported in error messages could be incorrect, #2605.\n- Fixed relative link detection for markdown links containing code in their label, #2606.\n- Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, #2607.\n- TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, #2609.\n- Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.\n- Fixed an issue where modifier tags were not applied to top level modules in packages mode.\n- Fixed an issue where excluded tags were not removed from top level modules in packages mode.\n- `.jsonc` configuration files are now properly read as JSONC, rather than being passed to `require`.\n\n### Thanks!\n\n- @KNU-K\n\n## v0.26.0 (2024-06-22)\n\n### Breaking Changes\n\n- Drop support for Node 16.\n- 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.\n This means that any projects setting `markedOptions` needs to be updated to use `markdownItOptions`.\n 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.\n- 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.\n As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,\n TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the `--highlightLanguages` option.\n- Changed default of `--excludePrivate` to `true`.\n- Renamed `--sitemapBaseUrl` to `--hostedBaseUrl` to reflect that it can be used for more than just the sitemap.\n- Removed deprecated `navigation.fullTree` option.\n- Removed `--media` option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.\n- Removed `--includes` option, use the `@document` tag instead.\n- Removed `--stripYamlFrontmatter` option, TypeDoc will always do this now.\n- Renamed the `--htmlLang` option to `--lang`.\n- Removed the `--gaId` option for Google Analytics integration and corresponding `analytics` theme member, #2600.\n- All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments\n 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.\n This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.\n As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will\n not be inherited by signatures of that function, #2521.\n- API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where `Converter.EVENT_CREATE_DECLARATION`\n was emitted for `ProjectReflection` in some circumstances.\n- API: `MapOptionDeclaration.mapError` has been removed.\n- API: Deprecated `BindOption` decorator has been removed.\n- API: `DeclarationReflection.indexSignature` has been renamed to `DeclarationReflection.indexSignatures`.\n Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.\n- API: `JSONOutput.SignatureReflection.typeParameter` has been renamed to `typeParameters` to match the JS API.\n- API: `DefaultThemeRenderContext.iconsCache` has been removed as it is no longer needed.\n- API: `DefaultThemeRenderContext.hook` must now be passed `context` if required by the hook.\n\n### Features\n\n- Added support for TypeScript 5.5.\n- Added new `--projectDocuments` option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.\n- TypeDoc now has the architecture in place to support localization. No languages besides English\n are currently shipped in the package, but it is now possible to add support for additional languages, #2475.\n- Added support for a `packageOptions` object which specifies options that should be applied to each entry point when running with `--entryPointStrategy packages`, #2523.\n- `--hostedBaseUrl` will now be used to generate a `` element in the project root page, #2550.\n- Added support for documenting individual elements of a union type, #2585.\n Note: This feature is only available on type aliases directly containing unions.\n- TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, #2581.\n- New option, `--customFooterHtml` to add custom HTML to the generated page footer, #2559.\n- TypeDoc will now copy modifier tags to children if specified in the `--cascadedModifierTags` option, #2056.\n- TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both `@alpha` and `@beta`), #2056.\n- Groups and categories can now be collapsed in the page body, #2330.\n- Added support for JSDoc `@hideconstructor` tag.\n This tag should only be used to work around TypeScript#58653, prefer the more general `@hidden`/`@ignore` tag to hide members normally, #2577.\n- Added `--useHostedBaseUrlForAbsoluteLinks` option to use the `--hostedBaseUrl` option to produce absolute links to pages on a site, #940.\n- Tag headers now generate permalinks in the default theme, #2308.\n- TypeDoc now attempts to use the \"most likely name\" for a symbol if the symbol is not present in the documentation, #2574.\n- Fixed an issue where the \"On This Page\" section would include markdown if the page contained headings which contained markdown.\n- TypeDoc will now warn if a block tag is used which is not defined by the `--blockTags` option.\n- Added three new sort strategies `documents-first`, `documents-last`, and `alphabetical-ignoring-documents` to order markdown documents.\n- Added new `--alwaysCreateEntryPointModule` option. When set, TypeDoc will always create a `Module` for entry points, even if only one is provided.\n If `--projectDocuments` is used to add documents, this option defaults to `true`, otherwise, defaults to `false`.\n- Added new `--highlightLanguages` option to control what Shiki language packages are loaded.\n- TypeDoc will now render union elements on new lines if there are more than 3 items in the union.\n- TypeDoc will now only render the \"Type Declaration\" section if it will provide additional information not already presented in the page.\n This results in significantly smaller documentation pages in many cases where that section would just repeat what has already been presented in the rendered type.\n- Added `comment.beforeTags` and `comment.afterTags` hooks for plugin use.\n Combined with `CommentTag.skipRendering` this can be used to provide custom tag handling at render time.\n\n### Bug Fixes\n\n- TypeDoc now supports objects with multiple index signatures, #2470.\n- Header anchor links in rendered markdown are now more consistent with headers generated by TypeDoc, #2546.\n- Types rendered in the `Returns` header are now properly colored, #2546.\n- Links added with the `navigationLinks` option are now moved into the pull out navigation on mobile displays, #2548.\n- `@license` and `@import` comments will be ignored at the top of files, #2552.\n- Fixed issue in documentation validation where constructor signatures where improperly considered not documented, #2553.\n- Keyboard focus is now visible on dropdowns and checkboxes in the default theme, #2556.\n- The color theme label in the default theme now has an accessible name, #2557.\n- Fixed issue where search results could not be navigated while Windows Narrator was on, #2563.\n- `charset` is now correctly cased in `` tag generated by the default theme, #2568.\n- Fixed very slow conversion on Windows where Msys git was used by typedoc to discover repository links, #2586.\n- Validation will now be run in watch mode, #2584.\n- Fixed an issue where custom themes which added dependencies in the `` element could result in broken icons, #2589.\n- `@default` and `@defaultValue` blocks are now recognized as regular blocks if they include inline tags, #2601.\n- Navigation folders sharing a name will no longer be saved with a shared key to `localStorage`.\n- The `--hideParameterTypesInTitle` option no longer applies when rendering function types.\n- Broken `@link` tags in readme files will now cause a warning when link validation is enabled.\n- Fixed `externalSymbolLinkMappings` option's support for [meanings](https://typedoc.org/guides/declaration-references/#meaning) in declaration references.\n- Buttons to copy code now have the `type=button` attribute set to avoid being treated as submit buttons.\n- `--hostedBaseUrl` will now implicitly add a trailing slash to the generated URL.\n\n### Thanks!\n\n- @Aryakoste\n- @bladerunner2020\n- @Dinnerbone\n- @HarelM\n- @kraenhansen\n- @Nil2000\n- @steve02081504\n- @tristanzander\n\n## v0.25.13 (2024-04-07)\n\n### Features\n\n- Added `gitRevision:short` placeholder option to `--sourceLinkTemplate` option, #2529.\n Links generated by TypeDoc will now default to using the non-short git revision.\n- Moved \"Generated by TypeDoc\" footer into a `