typedoc-github-theme
Advanced tools
Elegant and seamless look and feel for your TypeScript documentation on GitHub Pages
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.
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
👤 KillerJulian info@killerjulian.de
Contributions, issues and feature requests are welcome!
Feel free to check the issues page. You can also take a look at the contributing guide.
FAQs
Elegant and seamless look and feel for your TypeScript documentation on GitHub Pages
The npm package typedoc-github-theme receives a total of 4,577 weekly downloads. As such, typedoc-github-theme popularity was classified as popular.
We found that typedoc-github-theme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
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.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.