# typedoc-plugin-mdn-links

> Adds support for linking references to global types like `HTMLElement`, `WebAssembly`, and `Date` to their documentation pages on MDN.

Latest version **5.1.1** (published 2026-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install typedoc-plugin-mdn-links
pnpm add typedoc-plugin-mdn-links
yarn add typedoc-plugin-mdn-links
bun add typedoc-plugin-mdn-links
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: esm support; no vulnerabilities; has provenance.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 5.1.1 |
| Published | 2026-01-25 |
| First published | 2021-09-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 799.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 41 |
| Maintainers | gerrit0 |
| Keywords | typedoc-plugin |

## Links

- npm: https://www.npmjs.com/package/typedoc-plugin-mdn-links
- Repository: https://github.com/Gerrit0/typedoc-plugin-mdn-links
- Homepage: https://github.com/Gerrit0/typedoc-plugin-mdn-links#readme
- Issues: https://github.com/Gerrit0/typedoc-plugin-mdn-links/issues
- npm.io page: https://npm.io/package/typedoc-plugin-mdn-links

## Recent versions

- 5.1.1 (latest) — 2026-01-25
- 5.1.0 — 2026-01-19
- 5.0.10 — 2025-10-11
- 5.0.9 — 2025-08-24
- 5.0.8 — 2025-08-10
- 5.0.7 — 2025-08-03
- 5.0.6 — 2025-07-27
- 5.0.5 — 2025-07-20
- 5.0.4 — 2025-07-13
- 5.0.3 — 2025-07-06
- 5.0.2 — 2025-05-11
- 5.0.1 — 2025-03-02
- 5.0.0 — 2025-03-02
- 4.0.15 — 2025-03-02
- 4.0.14 — 2025-02-23
- … 80 more at https://npm.io/package/typedoc-plugin-mdn-links/versions

## README

# typedoc-plugin-mdn-links

Adds support for linking references to global types like `HTMLElement`,
`WebAssembly`, and `Date` to their documentation pages on MDN.

If you're explicitly referencing a type in a comment, you can use `{@link
!HTMLElement}` or `{@link HTMLElement}` to have it processed by this plugin.

If you set `--logLevel Verbose`, it will print out when failing to resolve a
symbol to a page on MDN. Pull requests to fix failed resolution are welcome!

Supports TypeDoc 0.27.x and 0.28.x

## Options

- `resolveUtilityTypes`

  Defaults to `true`. If set, will resolve links to `Partial`, `Omit`, etc. to
  their documentation on the TypeScript website.

- `additionalModuleSources`

  Defaults to `[]`. Specifies additional node_modules packages to attempt to
  resolve links to MDN from. By default, resolves types declared in the
  `typescript`, `@types/web`, and `@webgpu/types` packages. You should only
  need to set this option if using an unusual type package to define globally
  available types.

## Changelog

See full changelog [here](./CHANGELOG.md).

---
_Source: https://npm.io/package/typedoc-plugin-mdn-links · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._