Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

typedoc-plugin-mdn-links

Package Overview
Dependencies
Maintainers
0
Versions
66
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

typedoc-plugin-mdn-links

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

  • 3.3.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
15K
decreased by-85.15%
Maintainers
0
Weekly downloads
 
Created
Source

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.23.14 through 0.26.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.

Keywords

FAQs

Package last updated on 22 Sep 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc