Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stylishthemes/github-dark

:octocat: Dark GitHub style
https://github.com/stylishthemes/github-dark

awesome css dark dark-theme github theme usercss userstyle

Last synced: 3 months ago
JSON representation

:octocat: Dark GitHub style

Awesome Lists containing this project

README

        


githubdark-logo



Version


Stars


Forks


devDependencies


Gitter


Your eyes will :heart: you.

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

⚙️ [GitHub Blog Dark](https://github.com/StylishThemes/GitHub-Blog-Dark)

⚙️ [GitHub Code Wrap](https://github.com/StylishThemes/GitHub-code-wrap)

⚙️ [GitHub Commit Limit](https://github.com/StylishThemes/GitHub-Commit-Limit)

⚙️ [GitHub Community Dark](https://github.com/StylishThemes/Discourse-Dark) - Now part of Discourse Dark

⚙️ [GitHub Compact Feed](https://github.com/StylishThemes/GitHub-Compact-Feed)

⚙️ [GitHub Dark Calendar Color Customizer](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-calendar-color-customizer.user.css)

⚙️ [GitHub Dark Diff Color Customizer](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-diff-color-customizer.user.css)

⚙️ [GitHub Dark Element Borders](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-element-borders.user.css)

⚙️ [GitHub Dark IMG Background Color](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-img-bg-clr.user.css)

⚙️ [GitHub Feed Icons](https://github.com/StylishThemes/GitHub-Feed-Icons)

⚙️ [GitHub FixedHeader](https://github.com/StylishThemes/GitHub-FixedHeader)

⚙️ [GitHub Selected Tab Color](https://github.com/StylishThemes/GitHub-Selected-Tab-Color)

⚙️ [GitHub Sticky Sidebar](https://github.com/StylishThemes/GitHub-Sticky-Sidebar)

⚙️ [GitHub Tab Size](https://github.com/StylishThemes/GitHub-tab-size)

⚙️ [GitHub Custom Border Radii](https://github.com/StylishThemes/Feature-Override-Styles/blob/master/github-custom-border-radii.user.css)

⚙️ [GitHub Dark Custom Blame usercss](https://raw.githubusercontent.com/StylishThemes/Feature-Override-Styles/master/github-dark-custom-blame.user.css)

⚙️ [GitHub Upstream BugFixes usercss](https://github.com/StylishThemes/GitHub-Upstream-BugFixes/raw/master/github-upstream-bugfixes.user.css)

⚙️ [Overlay Scrollbars](https://github.com/StylishThemes/Overlay-Scrollbars)

## Supported GitHub Extensions

💾 [Gitako](https://github.com/EnixCoda/Gitako)

💾 [GitHub Notifications Dropdown](https://openuserjs.org/scripts/joeytwiddle/Github_Notifications_Dropdown)

💾 [GitHub Polls](https://github.com/apex/gh-polls)

💾 [Lovely forks](https://github.com/musically-ut/lovely-forks#lovely-forks)

💾 [Notifications Preview for GitHub](https://github.com/tanmayrajani/notifications-preview-github)

💾 [OctoLinker](https://github.com/OctoLinker/OctoLinker)

💾 [Octotree](https://github.com/buunguyen/octotree/#octotree)

💾 [Refined GitHub](https://github.com/sindresorhus/refined-github)

💾 [Sourcegraph Browser Extension](https://docs.sourcegraph.com/integration/browser_extension)

💾 [ZenHub](https://www.zenhub.com/)

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