- Go to VS Marketplace.
- Click on the "Install" button.
- Then select a theme. The GitHub themes try to match the themes available in github.com's settings:
GitHub Light Default
GitHub Dark Default
GitHub Dark Dimmed
GitHub Dark High Contrast
✨ new ✨
Additionally, there are also two older themes. Note: They won't get updated anymore and are kept for legacy reasons:
GitHub Light
(legacy)GitHub Dark
(legacy)
To quickly test something, you can also override this (or any other) theme in your personal config file. Please follow the guide in the color theme documentation.
- Clone and open this repo in VS Code
- Run
npm install
to install the Primer CSS color reference and runnpm start
to run the converter. - Press
F5
to open a new window with your extension loaded - Open
Code > Preferences > Color Theme
[⌘k ⌘t
] and pick the "GitHub Light" or "GitHub Dark" theme - Make changes to the
/src/theme.js
file.- UI: For all changes to the "outer UI", like (status bar, file navigation etc.), take a look at the Theme Color reference.
- Syntax: For changes to the "code highlighting", examine the syntax scopes by invoking the
Developer: Inspect Editor Tokens and Scopes
command from the Command Palette (Ctrl+Shift+P
orCmd+Shift+P
on Mac) in the Extension Development Host window.
- Commit your changes and open a PR.
Note:
- If possible use colors from Primer's color system.
- Changes to the theme files are automatically applied to the Extension Development Host window, so no reloading should be necessary.
Note: Publishing a new version of this theme is only meant for maintainers.
Prerequisite: Please follow this guide to install and login to vsce
. Ask an existing maintainer how to get the "Personal Access Token".
- Merge any PR that is ready to be published into
master
. - Run
npm run build
to generate the themes with the new changes. - Update CHANGELOG.md + commit the changes.
- Run
vsce publish [version]
. Follow the SemVer convention and replace[version]
with one of the following options:patch
for bug fixesminor
for improvementsmajor
for breaking or bigger changes
- Push the commits and make a new release.