Skip to content

Latest commit

 

History

History
131 lines (107 loc) · 9.21 KB

README.md

File metadata and controls

131 lines (107 loc) · 9.21 KB
Raw

githubdark-logo
Version Stars Forks devDependencies Gitter

Your eyes will :heart: you.

Preview

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.
📦 Install via custom build with customization from configuration file. Refer to this wiki page.

Additional Userstyles

⚙️ GitHub-FixedHeader
⚙️ GitHub-Selected-Tab-Color
⚙️ GitHub-code-wrap
⚙️ GitHub-tab-size
⚙️ GitHub-Commit-Limit
⚙️ GitHub-Community-Dark
⚙️ GitHub-Compact-Feed
⚙️ GitHub-Feed-Icons
⚙️ Overlay-Scrollbars
⚙️ GitHub-Sticky-Sidebar

Supported GitHub Addons

💾 GitHub Awesome Autocomplete
💾 GitHub Notifications Dropdown
💾 GitHub Polls
💾 Lovely forks
💾 npmhub
💾 Octotree
💾 OctoLinker
💾 Refined GitHub
💾 ZenHub
💾 GitHub Hovercard (set it to dark theme)

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

To develop, first install Node.js 12 or greater, then install dependencies via npm install after which you can use the various commands available:

  • npx grunt: The default grunt task builds a custom theme using a provided build.json file. See the wiki for details.
  • npm run usercss: Build a Usercss style.
  • npx grunt themes: Parse all theme files and combine them into minified styles in the themes directory.
  • npm run clean: Reformat github-dark.css to conform the style guide.
  • npm run lint: Run Stylelint on github-dark.css.
  • npm run authors: Regenerate the AUTHORS file based on git history.
  • npm run imagemin: Minify all images present in the image directory.
  • npm run generate: Regenerate auto-generated CSS rules based on GitHub's stylesheet. Run this regularly.
  • npm run patch: Increment the version on the patch version number, update headers and create a commit.
  • npm run minor: Increment the version on the minor version number, update headers and create a commit.
  • npm run major: Increment the version on the major version number, update headers and create a commit.
  • npm run update: Update and install dependencies.

Thanks to all that have contributed so far!

And thanks for the shoutout on the JS Party podcast!