Skip to content
This repository was archived by the owner on Dec 16, 2025. It is now read-only.

Commit f5adcee

Browse files
committed
docs: Update colorscheme docs
1 parent fa1fdca commit f5adcee

2 files changed

Lines changed: 105 additions & 2 deletions

File tree

docs/content/colorschemes.md

Lines changed: 97 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,14 @@ $ git clone [email protected]:cointop-sh/colors.git
1919
Then edit your config `~/.config/cointop/config.toml` and set the colorscheme you want to use:
2020

2121
```toml
22-
colorscheme = "<colorscheme>"
22+
colorscheme = "cointop"
2323
```
2424

2525
The colorscheme name is the name of the colorscheme TOML file.
2626

27-
For example, if you have `matrix.toml` in `~/.cointop/colors/` then the `colorscheme` property should be set to:
27+
By default, the colorscheme files should go under `~/.config/cointop/colors/`
28+
29+
For example, if you have `matrix.toml` under `~/.config/cointop/colors/matrix.toml` then the `colorscheme` property in `config.toml` should be set to:
2830

2931
```toml
3032
colorscheme = "matrix"
@@ -37,3 +39,96 @@ $ cointop --colorscheme matrix
3739
```
3840

3941
To create your own colorscheme; simply copy an existing [colorscheme](https://github.com/cointop-sh/colors/blob/master/cointop.toml), rename it, and customize the colors.
42+
43+
The default `cointop` colorscheme is shown below:
44+
45+
```toml
46+
colorscheme = "cointop"
47+
48+
base_fg = "white"
49+
base_bg = "black"
50+
51+
chart_fg = "white"
52+
chart_bg = "black"
53+
chart_bold = false
54+
55+
marketbar_fg = "white"
56+
marketbar_bg = "black"
57+
marketbar_bold = false
58+
59+
marketbar_label_active_fg = "cyan"
60+
marketbar_label_active_bg = "black"
61+
marketbar_label_active_bold = false
62+
63+
menu_fg = "white"
64+
menu_bg = "black"
65+
menu_bold = false
66+
67+
menu_header_fg = "black"
68+
menu_header_bg = "green"
69+
menu_header_bold = false
70+
71+
menu_label_fg = "yellow"
72+
menu_label_bg = "black"
73+
menu_label_bold = false
74+
75+
menu_label_active_fg = "yellow"
76+
menu_label_active_bg = "black"
77+
menu_label_active_bold = true
78+
79+
searchbar_fg = "white"
80+
searchbar_bg = "black"
81+
searchbar_bold = false
82+
83+
statusbar_fg = "black"
84+
statusbar_bg = "cyan"
85+
statusbar_bold = false
86+
87+
table_column_price_fg = "cyan"
88+
table_column_price_bg = "black"
89+
table_column_price_bold = false
90+
91+
table_column_change_fg = "white"
92+
table_column_change_bg = "black"
93+
table_column_change_bold = false
94+
95+
table_column_change_down_fg = "red"
96+
table_column_change_down_bg = "black"
97+
table_column_change_down_bold = false
98+
99+
table_column_change_up_fg = "green"
100+
table_column_change_up_bg = "black"
101+
table_column_change_up_bold = false
102+
103+
table_header_fg = "black"
104+
table_header_bg = "green"
105+
table_header_bold = false
106+
107+
table_header_column_active_fg = "black"
108+
table_header_column_active_bg = "cyan"
109+
table_header_column_active_bold = false
110+
111+
table_row_fg = "white"
112+
table_row_bg = "black"
113+
table_row_bold = false
114+
115+
table_row_active_fg = "black"
116+
table_row_active_bg = "cyan"
117+
table_row_active_bold = false
118+
119+
table_row_favorite_fg = "yellow"
120+
table_row_favorite_bg = "black"
121+
table_row_favorite_bold = false
122+
```
123+
124+
Supported colors are:
125+
126+
- `black`
127+
- `blue`
128+
- `cyan`
129+
- `green`
130+
- `magenta`
131+
- `red`
132+
- `white`
133+
- `yellow`
134+
- `default` - system default

docs/content/faq.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ draft: false
4141

4242
Copy an existing [colorscheme](https://github.com/cointop-sh/colors/blob/master/cointop.toml) to `~/.config/cointop/colors/` and customize the colors. Then run cointop with `--colorscheme <colorscheme>` to use the colorscheme.
4343

44+
## How do I make the background color transparent?
45+
46+
Change the background color options in the colorscheme file to `default` to use the system default color, eg. `base_bg = "default"`
47+
48+
## Why don't colorschemes support RGB or hex colors?
49+
50+
Some of the cointop underlying rendering libraries don't support true colors. See [issue](https://github.com/nsf/termbox/issues/37).
51+
4452
## Where is the config file located?
4553

4654
The default configuration file is located under `~/.config/cointop/config.toml`

0 commit comments

Comments
 (0)