Skip to content

Commit c806c5c

Browse files
committed
docs: update docs
1 parent 2635c01 commit c806c5c

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/samples/speed.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
# Speed samples
22

3-
The `speed` option must be one of `slow`, `normal` or `fast`.
3+
The `speed` option must be one of `auto`, `slow`, `normal` or `fast`.
44

55
Here are some `speed` samples:
66

7+
### speed=auto
8+
9+
The `auto` option set the snake speed based on the number of contribution dots, here is the rules:
10+
11+
- If you have less than 1/3 of the grid, the speed will be [slow](#speedslow)
12+
- If you have more than 1/3 but less than 2/3 of the grid, the speed will be [normal](#speednormal)
13+
- If you have more than 2/3 of the grid, the speed will be [fast](#speedfast)
14+
715
### speed=slow
816

917
<picture>

0 commit comments

Comments
 (0)