Created 2020-04-12 Sun 15:49
+OPTIONS: title:nil date:nil '
+AUTHOR: Brett Mandler
+startup: nofold
+macro: badge #+HTML: 
+macro: install {{{badge(Install Directly with Stylus,https://raw.githubusercontent.com/brettm12345/github-moonlight/master/github.user.css,badge/Install%20directly%20with-Stylus-116b59.svg?longCache=true)}}}
+export_file_name: ../readme
+html:
- Github Moonlight
A dark userstyle for GitHub inspired by [[https://github.com/atomiks/moonlight-vscode-theme][moonlight-vscode-theme]]
made with :heart:
+html: 
+html: 
+html: 
+html: 
+html: 
[[file:screenshots/repo.png]]
+html:
- Github Moonlight
A dark userstyle for GitHub inspired by [[https://github.com/atomiks/moonlight-vscode-theme][moonlight-vscode-theme]] made with :heart:
+html:
+html:
+html:
+html:
+html:
[[file:screenshots/repo.png]]
+html:
** Installation
You have to install [[https://add0n.com/stylus.html][Stylus]] and then click on the install link below.
+html:
Features ** Customization
All color and font variables are easily customizable check out [[file:build.ts][build.ts]] and [[file:github.user.css][github.user.css]] for reference.
**** Completeness
This theme changes 100% of the github ui. If you want to teak the colors to match the rest of your system go ahead! Forks and pull requests are welcome!
**** Speed
Github-Moonlight uses [[https://stylus-lang.com/docs/bifs.html#cachekeys][cached mixins]] from the stylus css preprocessor on top of compression to consolidate and minify selectors.
**** Transitions
This theme adds easings from [[https://easings.net][easings.net]] so that color changes appear smoother.
**** Clean Code
The theme being written in [[https://stylus-lang.com/][stylus-lang]] utilizing several [[https://github.com/Brettm12345/github-moonlight/blob/master/src/mixins.styl][mixins]] in order to minimize boilerplate.
**** Organization
Unlike virtually every other usercss. This project is organized into relevant files making it easy to manage and extend the code.
** Recommendations *** Fonts
These are the fonts used in the screenshots
- UI Font: [[https://rsms.me/inter/][Inter]]
- Code Font: [[https://www.jetbrains.com/lp/mono/][JetBrains Mono]]
*** Extensions
| Extension | Description | |-----------------------------------------------------------------------------+-----------------------------------------------| | [[https://github.com/EnixCoda/Gitako][Gitako]] | GitHub File tree | | [[https://github.com/sindresorhus/hide-files-on-github][Hide Files]] | Hides nonsensical files | | [[https://github.com/sindresorhus/refined-github][Refined Github]] | Adds a number of small enhancements to github | | [[https://github.com/musically-ut/lovely-forks][Lovely Forks]] | Displays notable forks on repo page | | [[https://github.com/dderevjanik/github-vscode-icons][github-vscode-icons]] | Adds vscode like icons to github | | [[https://github.com/OctoLinker/OctoLinker][OctoLinker]] | Links dependencies on github |
** Additional Screenshots
+macro: screenshot #+HTML: $1
$1
+html: Repo
Repo
+html: Profile
Profile
+html: Code
Code
+html: Commit Tree
Commit Tree
+html: Search
Search
+html: Dashboard (with Refined GitHub)
Dashboard (with Refined GitHub)
+html: Dashboard
Dashboard
+html: Pull Requests
Pull Requests
+html: Pull Request Review
Pull Request Review
+html: File Finder
File Finder
+html: Contribution Tree
Contribution Tree
+html: Markdown
Markdown
+html: Issues
Issues
+html: Diff
Diff
+html: Gist User
Gist User
+html: Gist File
Gist File
+html: Gist File Edit
Gist File Edit
+html: Explore
Explore
+html: Api Docs
Api Docs
+html: Actions
Actions
+html: File Editor
File Editor
+html: Projects
Projects
+html: Community
Community
+html: GraphQL Explorer
GraphQL Explorer
** Issues
If you find any places where this theme is incomplete please do not hesitate to create an issue. Most likely I have never visited the area of the site that is incomplete
** Discord Server
Feel free to join our [[https://discord.gg/n5meNsX][discord server]] for support/inquiries or just to chat.
** Contributions
Contributions are welcome! Please refer to the [[https://github.com/Brettm12345/github-moonlight/blob/master/.github/CONTRIBUTING.org][contribution guide]].