About this project
GitHub Dark is a comprehensive userstyle project developed by StylishThemes that transforms GitHub's interface into a dark theme, providing a more comfortable viewing experience for developers who spend long hours coding. The project is designed to work with popular browser extensions including Stylus for Firefox, Chrome, and Opera, as well as Cascadea for Safari.
The core functionality is delivered through a single CSS file (github-dark.user.css) that users can install via their preferred browser extension. The project also requires users to enable GitHub's native dark mode setting for optimal results.
One of the project's key features is its extensive support for syntax highlighting themes. The project provides compatibility with multiple theme options across three platforms: GitHub's native syntax highlighting, CodeMirror, and Jupyter notebooks. Supported themes include popular options such as Dracula, Monokai, Solarized Dark, One Dark, Tomorrow Night variants, and many more. Each theme is tested for compatibility across the different platforms, with a detailed compatibility matrix provided in the documentation.
The project offers numerous additional userstyles that can be combined with the main dark theme to further customize the GitHub experience. These include options for custom fonts, code wrapping, commit limits, compact feeds, feed icons, fixed headers, sticky sidebars, tab size adjustments, custom border radii, and more. Some of these additional styles are maintained in separate repositories within the StylishThemes organization.
GitHub Dark also maintains compatibility with various GitHub browser extensions, ensuring that the dark theme works seamlessly with popular tools like Gitako, GitHub Notifications Dropdown, GitHub Polls, Lovely Forks, Notifications Preview for GitHub, OctoLinker, Octotree, Refined GitHub, Sourcegraph Browser Extension, and ZenHub.
The project follows a structured development workflow with a build system based on Node.js (version 14 or greater) and make. The source files are organized in the src directory, with auto-generated CSS files produced from templates in the src/gen directory. Manual overrides can be added to handle specific styling needs. The build process includes targets for installing dependencies, building the CSS, installing the style, running linters, and formatting source files.
The project encourages community contributions through pull requests, with clear guidelines for adding new features, fixing issues, and completing missing theme support. The repository includes a detailed table of contents, preview images, and comprehensive documentation to help both users and contributors.
For GitHub Enterprise users with custom domains, the project provides guidance on configuring the userstyle to work with custom domains through @-moz-document rules in Firefox or the Applies to section in Chrome.
The project has been recognized in the developer community, including a shoutout on the JS Party podcast, and maintains an active contributor base as evidenced by the AUTHORS file generated from git history.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.