Skip to content

Commit ee7ab76

Browse files
committed
chore: Update documentation
1 parent 3e94043 commit ee7ab76

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,24 @@ block using the `gist:` protocol.
1414

1515
```md
1616
`gist:[<username>/]<gist_id>[#<gist_file>]`
17+
18+
or
19+
20+
`gist:[<username>/]<gist_id>[?file=<gist_file>&highlights=<number|ranges>]`
1721
```
1822

1923
Where:
2024
- **username**, represents the github handler whose gist is to be accessed.
2125
Can be defaulted via configuration.
2226
- **gist_id**, is the id of the gist to be accessed.
2327
This is the hash value in the gist url, e.g. https://gist.github.com/<username\>/`ce54fdb1e5621b5966e146026995b974`).
24-
- **gist_file**, is the name of the file in the gist to be accessed.
28+
- **gist_file**, is the name of the file in the gist to be accessed.
29+
30+
Highlights can be defined using:
31+
- A single number (e.g. `highlights=1`)
32+
- A list of numbers (e.g. `highlights=1,4`)
33+
- A range of numbers (e.g. `highlights=1-4`)
34+
- A combination of all above (e.g. `highlights=1,3,7-9`)
2535

2636
## Installation
2737

0 commit comments

Comments
 (0)