typedoc-plugin-mdn-links
Advanced tools
Adds support for linking references to global types like `HTMLElement`, `WebAssembly`, and `Date` to their documentation pages on MDN.
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
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.
See full changelog here.
FAQs
Adds support for linking references to global types like `HTMLElement`, `WebAssembly`, and `Date` to their documentation pages on MDN.
We found that typedoc-plugin-mdn-links demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
