typedoc-plugin-djs-links

Adds support for linking to discord.js.org for DiscordJS types to TypeDoc

Usage no npm install needed!

<script type="module">
  import typedocPluginDjsLinks from 'https://cdn.skypack.dev/typedoc-plugin-djs-links';
</script>

README

Sapphire Logo

typedoc-plugin-djs-links

Adds support for linking to MDN for global types to TypeDoc.

GitHub npm

Description

This is a plugin for typedoc that ad ds support for linking references to DiscordJS Classes and Interfaces to their documentation pages on https://discord.js.org.

If you find any links missing please set --logLevel Verbose when running TypeDoc. This will print out when failing to resolve a symbol to a page on the DiscordJS website. Pull requests to fix failed resolution are welcome!

This plugin is designed to work with Typedoc version 0.22.x

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With Address
Open Collective Click Here
Ko-fi Click Here
Patreon Click Here
PayPal Click Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Jeroen Claassens
💻 🚇 📆
renovate[bot]
🚧
WhiteSource Renovate
🚧

This project follows the all-contributors specification. Contributions of any kind welcome!