UNPKG

typedoc-plugin-konamimojisplosion

Version:

TypeDoc plugin to quickly integrate konamimojisplosion into your docs site. 🎉 ✨ 🎆

69 lines (55 loc) • 2.83 kB
<h1 align="center">TypeDoc Plugin Konamimojisplosion</h1> <p align="center">TypeDoc plugin to quickly integrate <a href="https://github.com/JoshuaKGoldberg/konamimojisplosion">Konamimojisplosion</a> into your docs site. 🎉 ✨ 🎆</p> <p align="center"> <a href="#contributors" target="_blank"> <!-- prettier-ignore-start --> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <img alt="All Contributors: 1" src="https://img.shields.io/badge/all_contributors-1-21bb42.svg" /> <!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- prettier-ignore-end --> </a> <a href="https://github.com/JoshuaKGoldberg/typedoc-plugin-konamimojisplosion/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"> <img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /> </a> <a href="https://github.com/JoshuaKGoldberg/typedoc-plugin-konamimojisplosion/blob/main/LICENSE.md" target="_blank"> <img alt="License: MIT" src="https://img.shields.io/github/license/JoshuaKGoldberg/typedoc-plugin-konamimojisplosion?color=21bb42"> </a> <a href="https://github.com/sponsors/JoshuaKGoldberg" target="_blank"> <img alt="Sponsor: On GitHub" src="https://img.shields.io/badge/sponsor-on_github-21bb42.svg" /> </a> <img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" /> <img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" /> </p> ## Usage Add this plugin in your `typedoc.json`: ```json { "plugin": ["typedoc-plugin-konamimojisplosion"] } ``` Then, pressing the [Konami Code](https://en.wikipedia.org/wiki/Konami_Code) on your TypeDoc site will trigger fireworks blasts of emoji on the page. Yay! 🎉 ✨ 🎆 ## Development See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md). Thanks! 💖 ## Contributors <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <!-- spellchecker: disable --> <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg"/><br /><sub><b>Josh Goldberg</b></sub></a><br /><a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END --> <!-- spellchecker: enable --> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> > 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [template-typescript-node-package](https://github.com/JoshuaKGoldberg/template-typescript-node-package).