Skip to content

Commit 121a686

Browse files
authored
Add info about settings.yaml options
1 parent 40c9472 commit 121a686

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,36 @@ Then you can use it with
99
```html
1010
<img src="https://your-gh-pagepurl/out.svg">
1111
```
12+
13+
## Configuring
14+
Example config u can see in `setting.yaml`
15+
```yaml
16+
general:
17+
top_k: 4 # how many sections will be on donut-chart (including "Other" section)
18+
plane:
19+
height: 140 # height of svg
20+
width: 250 # width of svg
21+
coloring:
22+
type: "github" # type of coloring (github or oklch available)
23+
other_color: "#666666" # color of "Other" section
24+
# coloring:
25+
# type: "oklch" # type of coloring (github or oklch available)
26+
# chroma: 0.099 # coloring oklch chroma
27+
# lightness: 0.636 # coloring oklch lightness
28+
# other_color: "#666666" # color of "Other" section
29+
excluded_languages: # list of languages that should be excluded
30+
- Jupyter Notebook # removed because jupyter files are too large
31+
32+
legend:
33+
margin_x: 140 # margin of legend (x-axis)
34+
margin_y: 30 # margin of legend (y-axis)
35+
space_between_captions: 22 # space between legend options
36+
font_color: "#c1c1c1" # font color
37+
38+
diagram:
39+
outer_radius: 55 # outer circle radius
40+
thickness: 12 # size of donut-chart
41+
margin_x: 20 # margin of diagram (x-axis)
42+
margin_y: 15 # margin of diagram (y-axis)
43+
```
44+
About **oklch** u can read [here](https://oklch.com/)

0 commit comments

Comments
 (0)