npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

typedoc-github-theme

v0.2.0

Published

Elegant and seamless look and feel for your TypeScript documentation on GitHub Pages

Downloads

22,146

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

killerjuliankillerjulian

Keywords

typedoc-themetypedoc-github-theme

Readme

Theme your TypeDoc like GitHub

NPM

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

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 [email protected]

🤝 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.