summaryrefslogtreecommitdiffstats
path: root/docs/Config.md
blob: 76cf4bcc0a9b425e374dc081d740754caec29a21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# User Config:

## Default:

```
  gui:
    # stuff relating to the UI
    scrollHeight: 2 # how many lines you scroll by
    theme:
      activeBorderColor:
        - white
        - bold
      inactiveBorderColor:
        - white
      optionsTextColor:
        - blue
    commitLength:
      show: true
  update:
    method: prompt # can be: prompt | background | never
    days: 14 # how often an update is checked for
  reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined'
```

## Platform Defaults:

### Windows:

```
  os:
    openCommand: 'cmd /c "start "" {{filename}}"'
```

### Linux:

```
  os:
    openCommand: 'sh -c "xdg-open {{filename}} >/dev/null"'
```

### OSX:

```
  os:
    openCommand: 'open {{filename}}'
```

### Recommended Config Values:

for users of VSCode

```
  os:
    openCommand: 'code -r {{filename}}'
```

## Color Attributes:

For color attributes you can choose an array of attributes (with max one color attribute)
The available attributes are:

- default
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
- bold
- reverse # useful for high-contrast
- underline

## Example Coloring:

![border example](/docs/resources/colored-border-example.png)