Skip to content
CSS HTML JavaScript Other
Branch: master
Clone or download

README.md

githubdark-logo
Version Stars Forks devDependencies Gitter

Your eyes will ❤️ you.

Preview

Preview of GitHub Dark

Installation

Install Stylus for either Firefox, Chrome or Opera or Cascadea for Safari and then install using one of these methods:

📦 Install the usercss which supports automatic updates and customization.
📦 Install GitHub-Dark Script which supports automatic updates and customization. Refer to its README.
📦 Install manually from GitHub with no customization, but useful for development. The style is in Mozilla format.

Additional Userstyles

⚙️ GitHub Blog Dark
⚙️ GitHub Code Wrap
⚙️ GitHub Commit Limit
⚙️ GitHub Community Dark
⚙️ GitHub Compact Feed
⚙️ GitHub Dark Calendar Color Customizer
⚙️ GitHub Dark Diff Color Customizer
⚙️ GitHub Dark Element Borders
⚙️ GitHub Dark IMG Background Color
⚙️ GitHub Feed Icons
⚙️ GitHub FixedHeader
⚙️ GitHub Selected Tab Color
⚙️ GitHub Sticky Sidebar
⚙️ GitHub Tab Size
⚙️ Overlay Scrollbars

Supported GitHub Extensions

💾 Gitako
💾 GitHub Hovercard
💾 GitHub Notifications Dropdown
💾 GitHub Polls
💾 Lovely forks
💾 npmhub
💾 OctoLinker
💾 Octotree
💾 Refined GitHub
💾 ZenHub
💾 Notifications Preview for GitHub

Available Syntax Highlighting Themes (Demo)

Theme GitHub CodeMirror Jupyter
Ambiance ✔️ ✔️
Base16 Ocean Dark ✔️ ✔️
Chaos ✔️
Clouds Midnight ✔️
Cobalt ✔️ ✔️
Dracula ✔️ ✔️
GitHub Dark ✔️ ✔️
Idle Fingers ✔️ ✔️
Kr Theme ✔️
Material 🚧 ✔️
Merbivore ✔️
Merbivore Soft ✔️
Mono Industrial ✔️
Mono Industrial Clear ✔️
Monokai ✔️ ✔️ ✔️
Monokai Spacegray Eighties ✔️ ✔️ ✔️
Obsidian ✔️ ✔️
One Dark ✔️ ✔️
Pastel on Dark ✔️ ✔️ ✔️
Railscasts ✔️ ✔️ ✔️
Solarized Dark ✔️ ✔️ ✔️
Terminal ✔️
Tomorrow Night ✔️ ✔️
Tomorrow Night Blue ✔️ ✔️
Tomorrow Night Bright ✔️ ✔️ ✔️
Tomorrow Night Eighties ✔️ ✔️ ✔️
Twilight (default) ✔️ ✔️ ✔️
Vibrant Ink ✔️ ✔️
  • Support for Codemirror and Jupyter notebook syntax highlighting themes as listed above.
  • Please provide a pull request if you have or want to create a missing theme, or help complete the theme(s) designated with a construction symbol (🚧).

Notes

  • If you're using a custom domain for GitHub Enterprise, be sure to include it through a @-moz-document rule (Firefox) or add it to the Applies to section in (Chrome).

Contributions

If you would like to contribute to this repository, please...

  1. 👓 Read the contribution guidelines.
  2. fork Fork or cloud-download download this repository.
  3. 👌 Create a pull request!

Development

First, make sure you have these installed:

  • node: version 12 or greater
  • yarn: version 1
  • make: comes with Unix-like OS, on Windows use this

To get started, run make deps after which you can use the following make targets:

  • make build: Runs the generate and usercss tasks.
  • make usercss: Build the Usercss style.
  • make themes: Parse the theme files and combine them into minified styles in the themes directory.
  • make clean: Reformat github-dark.css to conform the style guide.
  • make lint: Run Stylelint on github-dark.css.
  • make authors: Regenerate the AUTHORS file based on git history.
  • make generate: Regenerate auto-generated CSS rules compiled from various public sources.
  • make patch: Increment the patch version number, update file headers, create a commit and push it to origin.
  • make minor: Increment the minor version number, update file headers, create a commit and push it to origin.
  • make major: Increment the major version number, update file headers, create a commit and push it to origin.
  • make update: Update and install dependencies.

Thanks to all that have contributed so far!

And thanks for the shoutout on the JS Party podcast!

You can’t perform that action at this time.