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. |
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 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.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.
