Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

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.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

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 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

typedoc-theme-dark

v0.0.5

Published

2 years ago

Dark/light (prefers-color-scheme) theme for TypeDoc.

Downloads

5

0High
0Medium
0Low

typescript documentation generator typedoc-theme

Dark/light theme for TypeDoc

This theme will use the color scheme the user prefers. Setting CSS variables to set the color variables. Defaults to the dark theme if no preference.

@media (prefers-color-scheme: dark)

Install

npm add --dev typedoc-theme-dark

screen2

screen3-light

Usage

typedoc ./file.ts --theme ./node_modules/typedoc-theme-dark/dist/dark/

Build

To make a build:

npm run build

This puts the theme you want to use in dist/dark/.

typedoc ./file.ts --theme path/to/dist/dark/

Custom CSS Variables

I put a good effort into updating all the colors to use CSS Variables. This allows us to use the built in @media(prefers-color-scheme: x) to change the color. If you want to make a theme with color schemes, this might be good to fork and start with.

See: src/default/assets/css/_constants.sass

As a side note, this seems to work for me. I forked the https://github.com/TypeStrong/typedoc-default-themes repo and kept a lot of things. If there is something wrong or could be done better, make an issue or merge request.

Visit https://typedoc.org/ to learn more about TypeDoc. Theme Docs: https://typedoc.org/guides/themes/

License

Copyright (c) 2020 Dave Lage Copyright (c) 2015 Sebastian Lenz. Copyright (c) 2016-2020 TypeDoc Contributors. Licensed under the Apache License 2.0.