UNPKG

typedoc-plugin-discord-types

Version:

Adds support for linking to discord-api-types.dev types to TypeDoc.

52 lines (32 loc) 2.62 kB
<div align="center"> typedoc-plugin-discord-types **Adds support for linking to discord-api-types.dev types to TypeDoc.** [![GitHub](https://img.shields.io/github/license/imranbarbhuiya/typedoc-plugin-discord-types)](https://github.com/imranbarbhuiya/typedoc-plugin-discord-types/blob/main/LICENSE) [![npm](https://img.shields.io/npm/v/typedoc-plugin-discord-types?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/typedoc-plugin-discord-types) </div> ## Install You can use the following command to install this package, or replace `npm install -D` with your package manager of choice. ```bash npm install -D typedoc-plugin-discord-types ``` ## Usage After installation plugin automatically loads and creates links to discord-api-types documentation. ## Buy me some doughnuts If you want to support me by donating, you can do so by using any of the following methods. Thank you very much in advance! <a href="https://www.buymeacoffee.com/parbez" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a> <a href='https://ko-fi.com/Y8Y1CBIJH' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi4.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a> ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://github.com/imranbarbhuiya"><img src="https://avatars.githubusercontent.com/u/74945038?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Parbez</b></sub></a><br /><a href="https://github.com/imranbarbhuiya/typedoc-plugin-discord-types/commits?author=imranbarbhuiya" title="Code">💻</a> <a href="#maintenance-imranbarbhuiya" title="Maintenance">🚧</a> <a href="#ideas-imranbarbhuiya" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="https://renovate.whitesourcesoftware.com"><img src="https://avatars.githubusercontent.com/u/25180681?v=4?s=100" width="100px;" alt=""/><br /><sub><b>WhiteSource Renovate</b></sub></a><br /><a href="#maintenance-renovate-bot" title="Maintenance">🚧</a></td> </tr> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END --> This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!