Theme your TypeDoc like GitHub

This TypeDoc theme is designed to provide an elegant and seamless look and feel for your TypeScript documentation on GitHub Pages, inspired by the GitHub design.

Example

Usage

Install the package with your favourite package manager:

npm install typedoc-github-theme

pnpm install typedoc-github-theme

yarn add typedoc-github-theme

Use the theme when generating your documentation:

npx typedoc src --plugin typedoc-github-theme

Note

This plugin fills the following options if they have not been defined by the user: theme, lightHighlightTheme, darkHighlightTheme

---

Author

👤 KillerJulian info@killerjulian.de

• Github: @KillerJulian

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check the issues page. You can also take a look at the contributing guide.