Skip to content

Commit e4a339e

Browse files
authored
Merge pull request #57 from gitkraken/update-readme
Add theme feature to README
2 parents 39d1203 + e87e72f commit e4a339e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,31 @@ Then edit your environment variables to add it to your PATH.
123123
### Nerd Fonts
124124
The GitKraken CLI supports Nerd Fonts to display icons for some commands. To ensure correct icon rendering, please obtain and install a Nerd Font available at https://www.nerdfonts.com/. After installation, set the selected Nerd Font as the default font for your terminal.
125125

126+
### Themes
127+
Customize your experience with the theme system. This feature allows you to create custom color schemes and adapt the interface to your preference in both light and dark environments.
128+
129+
#### Creating a custom theme
130+
1. Navigate to the installation folder
131+
2. Create a new JSON file inside the ```themes``` folder
132+
3. Define colors using hexadecimal codes inside the new file. You can see all possible options in the default theme ```gk_theme.json```.
133+
134+
- There are two possible options to define colors:
135+
136+
```
137+
"accent": {
138+
"dark": "93A9EC",
139+
"light": "93A9EC"
140+
}
141+
```
142+
or
143+
144+
```
145+
"accent": "93A9EC"
146+
```
147+
148+
4. Execute ```gk setting --theme NAME_OF_THE_NEW_FILE```
149+
5. View the changes with ```gk setting theme```
150+
126151
## Troubleshooting
127152
128153
### ```gk login``` freezes after authenticating in browser

0 commit comments

Comments
 (0)