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

v5.0.2 (2025-05-10)

• Updated MDN API index with @mdn/browser-compat-data version 6.0.13

v5.0.1 (2025-03-02)

• Correct documented TypeDoc support in README.

v5.0.0 (2025-03-02)

• Breaking: Drop support for TypeDoc 0.26.x
• Add support for TypeDoc 0.28.x

v4.0.15 (2025-03-02)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.43

v4.0.14 (2025-02-23)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.41

v4.0.13 (2025-02-16)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.39

v4.0.12 (2025-02-09)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.37

v4.0.11 (2025-02-02)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.35

v4.0.10 (2025-01-26)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.33

v4.0.9 (2025-01-19)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.31

v4.0.8 (2025-01-12)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.29

v4.0.7 (2025-01-05)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.27

v4.0.6 (2024-12-22)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.26

v4.0.5 (2024-12-15)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.24

v4.0.4 (2024-12-08)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.22

v4.0.3 (2024-12-01)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.20

v4.0.2 (2024-11-27)

• Fix plugin when running with TypeDoc 0.27.x (@blutorange)
• Updated MDN API index with @mdn/browser-compat-data version 5.6.19

v4.0.1 (2024-11-24)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.18

v4.0.0 (2024-11-22)

• Breaking: Drop support for TypeDoc before 0.26.0
• Add support for TypeDoc 0.27.x
• Fix issue when linking to static methods on global objects, #22

v3.3.8 (2024-11-17)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.15

v3.3.7 (2024-11-10)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.14

v3.3.6 (2024-11-03)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.12

v3.3.5 (2024-10-27)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.10

v3.3.4 (2024-10-20)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.8

v3.3.3 (2024-10-13)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.6

v3.3.2 (2024-09-29)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.4

v3.3.1 (2024-09-22)

• Updated MDN API index with @mdn/browser-compat-data version 5.6.2

v3.3.0 (2024-09-19)

• Added support for resolving @link tags which reference globals from supported module sources, #21. Prior to TypeDoc 0.26.8, this may result in some unexpected link text if the @link tag is specified with custom link text.
• Updated MDN API index with @mdn/browser-compat-data version 5.6.1

v3.2.12 (2024-09-08)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.51

v3.2.11 (2024-09-01)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.49

v3.2.10 (2024-08-25)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.48

v3.2.9 (2024-08-18)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.46

v3.2.8 (2024-08-11)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.45

v3.2.7 (2024-08-04)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.44

v3.2.6 (2024-07-28)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.42

v3.2.5 (2024-07-21)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.40

v3.2.4 (2024-07-14)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.39

v3.2.3 (2024-07-07)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.37

v3.2.2 (2024-06-30)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.35

v3.2.1 (2024-06-23)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.34

v3.2.0 (2025-06-22)

• Support TypeDoc 0.26

v3.1.30 (2024-06-16)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.33

v3.1.29 (2024-06-09)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.32

v3.1.28 (2024-06-02)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.31

v3.1.27 (2024-05-24)

• Added support for linking Iterable type references (@mariano-perez-rodriguez)

v3.1.26 (2024-05-19)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.29

v3.1.25 (2024-05-12)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.27

v3.1.24 (2024-05-05)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.25

v3.1.23 (2024-04-28)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.23

v3.1.22 (2024-04-21)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.22

v3.1.21 (2024-04-14)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.21

v3.1.20 (2024-04-10)

• Added NoInfer link resolution for TypeScript utility types (@xuhdev)

v3.1.19 (2024-03-31)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.18

v3.1.18 (2024-03-10)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.14

v3.1.17 (2024-02-25)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.11

v3.1.16 (2024-02-11)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.10

v3.1.15 (2024-02-04)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.9

v3.1.14 (2024-01-28)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.8

v3.1.13 (2024-01-21)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.7

v3.1.12 (2024-01-14)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.6

v3.1.11 (2024-01-07)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.4

v3.1.10 (2023-12-31)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.3

v3.1.9 (2023-12-24)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.2

v3.1.8 (2023-12-17)

• Updated MDN API index with @mdn/browser-compat-data version 5.5.0

v3.1.7 (2023-12-10)

• Updated MDN API index with @mdn/browser-compat-data version 5.4.5

v3.1.6 (2023-12-03)

• Updated MDN API index with @mdn/browser-compat-data version 5.4.3

v3.1.5 (2023-11-26)

• Updated MDN API index with @mdn/browser-compat-data version 5.4.1

v3.1.4 (2023-11-19)

• Updated MDN API index

v3.1.3 (2023-11-18)

• Fixed broken publish due to missing data folder, #14.

v3.1.2 (2023-11-18)

• Updated MDN API index

v3.1.1 (2023-11-18)

• Updated MDN API index
• Fixed links to types defined in @types/web, #13

v3.1.0 (2023-08-25)

• Added support for TypeDoc 0.25.x.

v3.0.2 (2023-03-09)

• Add support for resolving TypeScript utility types (Partial, Omit, etc.) to links on the TypeScript website. This can be turned off with the new resolveUtilityTypes option.

v3.0.2 (2023-03-10)

• Fixed invalid published package (@WikiRik)

v3.0.1 (2023-03-09)

• Add support for {@link !NaN} to link to global symbols, #4
• Fix links to Intl/WebAssembly namespace members
• In TypeDoc versions 0.23.26 and later will now use the symbol name as the default link test

v3.0.0 (2023-03-09)

• Add support for TypeDoc 0.24 (@ocavue)
• Drop support for TypeDoc 0.22

v2.0.2 (2022-12-22)

• Add missing AsyncGenerator and AsyncGeneratorFunction pages (@achingbrain)

v2.0.1 (2022-12-16)

• Add many missing links (@achingbrain)

v2.0.0 (2022-06-26)

• Support TypeDoc 0.23
• Drop support for Node 12

v1.0.6 (2022-04-09)

• Added support for WebAudio and Canvas APIs (@johh)

v1.0.5 (2022-01-26)

• Fixed repository reference so that npm will link to GitHub (@mikaello)

v1.0.4 (2021-09-05)

• Added missing link for base HTMLElement interface.

v1.0.3 (2021-09-05)

• Added support for HTML element types (HTMLAnchorElement, HTMLButtonElement, etc.)

v1.0.2 (2021-09-05)

• Added typedocplugin to keywords so that TypeDoc will now automatically load this plugin if installed.