# Repository: StylishThemes/GitHub-Dark
# Stars: 9920

## README.md

<p align="center">
  <img alt="githubdark-logo" src="https://cdn.jsdelivr.net/gh/StylishThemes/logos@master/github.dark/githubdark-mini.svg" width="580">
  <br>
  <a href="https://github.com/StylishThemes/GitHub-Dark/tags">
    <img src="https://img.shields.io/github/tag/StylishThemes/GitHub-Dark.svg?label=version&style=flat" alt="Version">
  </a>
  <a href="https://github.com/StylishThemes/GitHub-Dark/stargazers">
    <img src="https://img.shields.io/github/stars/StylishThemes/GitHub-Dark.svg?style=flat" alt="Stars">
  </a>
  <a href="https://github.com/StylishThemes/GitHub-Dark/network">
    <img src="https://img.shields.io/github/forks/StylishThemes/GitHub-Dark.svg?style=flat" alt="Forks">
  </a>
  <a href="https://david-dm.org/StylishThemes/GitHub-Dark?type=dev">
    <img src="https://img.shields.io/david/dev/StylishThemes/GitHub-Dark.svg?label=devDependencies&style=flat" alt="devDependencies">
  </a>
  <a href="https://gitter.im/StylishThemes/GitHub-Dark">
    <img src="https://img.shields.io/gitter/room/StylishThemes/Github-Dark.js.svg?maxAge=2592000&style=flat" alt="Gitter">
  </a>
</p>
<h2 align="center">Your eyes will&nbsp;:heart:&nbsp;you.</h2>

# TOC
  * [Preview](#preview)
  * [Installation](#installation)
    * [Additional Userstyles](#additional-userstyles)
    * [Supported GitHub Extensions](#supported-github-extensions)
    * [Available Syntax Highlighting Themes](#available-syntax-highlighting-themes-demo)
  * [Contributions and Development](#contributions-and-development)
    * [Auto generated CSS](#auto-generated-css)
    * [Manual override entries](#manual-override-entries)
    * [Make targets](#make-targets)
  * [Notes](#notes)


## Preview

![Preview of GitHub Dark](./images/screenshot.png)

## Installation

1. Install [Stylus for Firefox](https://addons.mozilla.org/en-US/firefox/addon/styl-us/), [Chrome](https://chrome.google.com/webstore/detail/stylus/clngdbkpkpeebahjckkjfobafhncgmne), [Opera](https://addons.opera.com/en-gb/extensions/details/stylus/) or [Cascadea for Safari](https://cascadea.app/).
2. Install [github-dark.user.css](https://raw.githubusercontent.com/StylishThemes/GitHub-Dark/master/github-dark.user.css).
3. Set GitHub itself to [dark mode](https://github.com/settings/appearance).

## Additional Userstyles

⚙️ [GitHub Custom Fonts](https://raw.githubusercontent.com/StylishThemes/GitHub-Dark/master/github-custom-fonts.user.css)<br>
⚙️ [GitHub Blog Dark](https://github.com/StylishThemes/GitHub-Blog-Dark)<br>
⚙️ [GitHub Code Wrap](https://github.com/StylishThemes/GitHub-code-wrap)<br>
⚙️ [GitHub Commit Limit](https://github.com/StylishThemes/GitHub-Commit-Limit)<br>
⚙️ [GitHub Community Dark](https://github.com/StylishThemes/Discourse-Dark) - Now part of Discourse Dark<br>
⚙️ [GitHub Compact Feed](https://github.com/StylishThemes/GitHub-Compact-Feed)<br>
⚙️ [GitHub Dark Calendar Color Customizer](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-calendar-color-customizer.user.css)<br>
⚙️ [GitHub Dark Diff Color Customizer](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-diff-color-customizer.user.css)<br>
⚙️ [GitHub Dark Element Borders](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-element-borders.user.css)<br>
⚙️ [GitHub Dark IMG Background Color](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-img-bg-clr.user.css)<br>
⚙️ [GitHub Feed Icons](https://github.com/StylishThemes/GitHub-Feed-Icons)<br>
⚙️ [GitHub FixedHeader](https://github.com/StylishThemes/GitHub-FixedHeader)<br>
⚙️ [GitHub Selected Tab Color](https://github.com/StylishThemes/GitHub-Selected-Tab-Color)<br>
⚙️ [GitHub Sticky Sidebar](https://github.com/StylishThemes/GitHub-Sticky-Sidebar)<br>
⚙️ [GitHub Tab Size](https://github.com/StylishThemes/GitHub-tab-size)<br>
⚙️ [GitHub Custom Border Radii](https://github.com/StylishThemes/Feature-Override-Styles/blob/master/github-custom-border-radii.user.css)<br>
⚙️ [GitHub Dark Custom Blame usercss](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-custom-blame.user.css)<br>
⚙️ [GitHub Upstream BugFixes usercss](https://github.com/StylishThemes/GitHub-Upstream-BugFixes/raw/master/github-upstream-bugfixes.user.css)<br>
⚙️ [Overlay Scrollbars](https://github.com/StylishThemes/Overlay-Scrollbars)<br>

## Supported GitHub Extensions

💾 [Gitako](https://github.com/EnixCoda/Gitako)<br>
💾 [GitHub Notifications Dropdown](https://openuserjs.org/scripts/joeytwiddle/Github_Notifications_Dropdown)<br>
💾 [GitHub Polls](https://github.com/apex/gh-polls)<br>
💾 [Lovely forks](https://github.com/musically-ut/lovely-forks#lovely-forks)<br>
💾 [Notifications Preview for GitHub](https://github.com/tanmayrajani/notifications-preview-github)<br>
💾 [OctoLinker](https://github.com/OctoLinker/OctoLinker)<br>
💾 [Octotree](https://github.com/buunguyen/octotree/#octotree)<br>
💾 [Refined GitHub](https://github.com/sindresorhus/refined-github)<br>
💾 [Sourcegraph Browser Extension](https://docs.sourcegraph.com/integration/browser_extension)<br>
💾 [ZenHub](https://www.zenhub.com/)<br>

## Available Syntax Highlighting Themes ([Demo](https://stylishthemes.github.io/GitHub-Dark/))

| Theme                      |   GitHub    |  CodeMirror  |    Jupyter   |
|----------------------------|:-----------:|:------------:|:------------:|
| Ayu Mirage                 |      ✔️     |      ❌     |      ❌      |
| Ambiance                   |      ✔️     |      ✔️     |      ❌      |
| Base16 Ocean Dark          |      ❌     |      ✔️     |      ✔️      |
| Chaos                      |      ✔️     |      ❌     |      ❌      |
| Clouds Midnight            |      ✔️     |      ❌     |      ❌      |
| Cobalt                     |      ✔️     |      ✔️     |      ❌      |
| Dracula                    |      ✔️     |      ✔️     |      ✔️      |
| GitHub Dark                |      ✔️     |      ❌     |      ✔️      |
| Idle Fingers               |      ✔️     |      ❌     |      ✔️      |
| Kr Theme                   |      ✔️     |      ❌     |      ❌      |
| Material                   |   [🚧][1]   |      ✔️     |      ❌      |
| 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](https://codemirror.net/demo/theme.html) and [Jupyter notebook](https://github.com/sujitpal/statlearning-notebooks/blob/master/src/chapter2.ipynb) 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 (🚧).

[1]:https://github.com/StylishThemes/GitHub-Dark/pull/568

## Contributions and Development

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

1. [![fork](https://user-images.githubusercontent.com/136959/42383736-c4cb0db8-80fd-11e8-91ca-12bae108bccc.png) Fork](https://github.com/StylishThemes/GitHub-Dark/fork)
2. Make sure you have these installed:

- [`node`](https://nodejs.org): version 14 or greater with npm
- `make`: available with UNIX-like OS, on Windows you can use [this](https://stackoverflow.com/a/54086635/808699)

3. run `make build install` to rebuild the style and install in the default browser.

Any custom changes should be done in the files in the `src` directory. Do not edit the `.css` files in the project root, these are generated.

### Auto-generated CSS

Contributing e.g. unstyled items, sources, extensions, etc. to name a few.

See and edit the respective files in [/src/gen/](./src/gen/) then run `make build install` to rebuild and reinstall the style, then test your fixes and send a pull request.

### Manual override entries

Manual overrides to e.g. generated content or inline HTML styles to name a few.

See and edit respective files in [`src`](./src) then run `make build install` to rebuild and reinstall the style, then test your fixes and send a pull request.

### Make targets

- `make deps`: Install development dependencies into `Github Dark/node_modules`
- `make build`: Build `github-dark.user.css`
- `make install`: Install `github-dark.user.css`
- `make lint`: Run linters
- `make clean`: Format source files

Lesser used targets include:

- `make authors`: Regenerate the `AUTHORS` file based on git history
- `make update`: Update dependencies
- `make`: Alias for `make build`

Internal use only targets include:

- `make patch`: Increment the patch version, create a commit and push it
- `make minor`: Increment the minor version, create a commit and push it
- `make major`: Increment the major version, create a commit and push it

## 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).

Thanks to all our [contributors](./AUTHORS) so far! And thanks for the shoutout on the [JS Party](https://changelog.com/jsparty/20#transcript-71) podcast!

[⬆️ UP](#toc)