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} 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.23.x, 0.24.x and 0.25.x
| Option | Default | Description |
|---|---|---|
| resolveUtilityTypes | true | Resolve links to Partial, Omit, etc. to their documentation on the TypeScript website. |
| additionalModuleSources | false | Specify additional node_modules to attempt to resolve links to MDN from. |
NoInfer link resolution for TypeScript utility types (@xuhdev)@types/web, #13Partial, Omit, etc.) to links on the TypeScript website.
This can be turned off with the new resolveUtilityTypes option.{@link !NaN} to link to global symbols, #4AsyncGenerator and AsyncGeneratorFunction pages (@achingbrain)HTMLElement interface.HTMLAnchorElement, HTMLButtonElement, etc.)typedocplugin to keywords so that TypeDoc will now automatically load this plugin if installed.v3.1.24 (2024-05-05)
FAQs
Adds support for linking references to global types like `HTMLElement`, `WebAssembly`, and `Date` to their documentation pages on MDN.
The npm package typedoc-plugin-mdn-links receives a total of 0 weekly downloads. As such, typedoc-plugin-mdn-links popularity was classified as not popular.
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 0 open source maintainers 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
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.