iamsingularity / github-dark-style Goto Github PK

A userstyle extension is required, common ones include:

🎨 Stylus for Firefox, Chrome and Opera.
🎨 Stylish for Safari.
🎨 FreeStyler for Chrome.

Then install using one of these methods:

📦 Install the usercss with Stylus or FreeStyler. Supports automatic updates.
📦 Install GitHub-Dark Script which supports automatic updates and live customization. Refer to here.
📦 Install from userstyles.org with customization, does not support automatic updates.
📦 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.

⚙️ GitHub-code-wrap to wrap long lines in code boxes.
⚙️ GitHub-Commit-Limit to show line length limits when editing a commit message.
⚙️ GitHub-FixedHeader to have a fixed header.
⚙️ GitHub-Selected-Tab-Color to customize tab colors.
⚙️ GitHub-tab-size to set a fixed tab size in code.

💾 GitHub Awesome Autocomplete
💾 GitHub canned responses (deprecated; extension no longer maintained)
💾 GitHub Notifications Dropdown (userscript)
💾 GitHub Polls
💾 Lovely forks
💾 npmhub
💾 Octotree
💾 OctoLinker
💾 Refined GitHub
💾 ZenHub

• 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.

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

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

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

To develop, first install Node.js, install dependencies via npm install and install grunt via npm install -g grunt. After that, you can use the various grunt tasks available:

• grunt: The default task will build a custom theme using a provided build.json file. See the wiki for details.
• grunt min: Same as grunt, but outputs a minified style.
• grunt user: Build a userstyle ready to be pasted on userstyles.org.
• grunt usermin: Same as grunt user, but outputs a minified style.
• grunt usercss: Build a Usercss style, to be used with modern userstyle engines like stylus.
• grunt themes: Parse all theme files and combine them into minified styles in the themes directory.
• grunt clean: Reformat github-dark.css to conform the style guide.
• grunt lint: Run Stylelint on github-dark.css.
• grunt authors: Regenerate the AUTHORS file based on git history.
• grunt imagemin: Minify all images present in the image directory.
• grunt generate: Regenerate auto-generated CSS rules based on GitHub's stylesheet. This should be ran regularly.
• grunt patch: Increment the version on the patch version number. Also updates headers and creates a commit.
• grunt minor: Increment the version on the minor version number. Also updates headers and creates a commit.
• grunt major: Increment the version on the major version number. Also updates headers and creates a commit.
• grunt update: Update and install dependencies.

Thanks to all that have contributed so far!

And thanks for the shoutout on the JS Party podcast!