Skip to content

Commit c086c3a

Browse files
authored
fix(tests): fixes broken tests (#28)
1 parent f494428 commit c086c3a

File tree

4 files changed

+753
-38
lines changed

4 files changed

+753
-38
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ To embed a Gist snippet in you markdown/remark content, simply add an inline cod
1313
block using the `gist:` protocol.
1414

1515
```md
16-
`gist:[<username>/]<gist_id>[#<gist_file>]`
17-
18-
or
19-
20-
`gist:[<username>/]<gist_id>[?file=<gist_file>&highlights=<number|ranges>]`
16+
`gist:[<username>/]<gist_id>#<gist_file>`
17+
`gist:[<username>/]<gist_id>#<gist_file>?lines=<number|ranges>`
18+
`gist:[<username>/]<gist_id>#<gist_file>?highlights=<number|ranges>`
19+
`gist:[<username>/]<gist_id>#<gist_file>?highlights=<number|ranges>&lines=<number|ranges>`
20+
`gist:[<username>/]<gist_id>?file=<gist_file>`
21+
`gist:[<username>/]<gist_id>?file=<gist_file>?lines=<number|ranges>`
22+
`gist:[<username>/]<gist_id>?file=<gist_file>?highlights=<number|ranges>`
23+
`gist:[<username>/]<gist_id>?file=<gist_file>?highlights=<number|ranges>&lines=<number|ranges>`
2124
```
2225

2326
Where:
@@ -27,11 +30,11 @@ Can be defaulted via configuration.
2730
This is the hash value in the gist url, e.g. https://gist.github.com/<username\>/`ce54fdb1e5621b5966e146026995b974`).
2831
- **gist_file**, is the name of the file in the gist to be accessed.
2932

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`)
33+
Highlights and lines can be defined using:
34+
- A single number (e.g. `highlights=1`, `lines=1`)
35+
- A list of numbers (e.g. `highlights=1,4`, `lines=1,4`)
36+
- A range of numbers (e.g. `highlights=1-4`, `lines=1-4`)
37+
- A combination of all above (e.g. `highlights=1,3,7-9`, `lines=1,3,7-9`)
3538

3639
## Installation
3740

0 commit comments

Comments
 (0)