Skip to content

Commit

Permalink
fix(tests): fixes broken tests (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
weirdpattern authored Jun 26, 2020
1 parent f494428 commit c086c3a
Show file tree
Hide file tree
Showing 4 changed files with 753 additions and 38 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,14 @@ To embed a Gist snippet in you markdown/remark content, simply add an inline cod
block using the `gist:` protocol.

```md
`gist:[<username>/]<gist_id>[#<gist_file>]`

or

`gist:[<username>/]<gist_id>[?file=<gist_file>&highlights=<number|ranges>]`
`gist:[<username>/]<gist_id>#<gist_file>`
`gist:[<username>/]<gist_id>#<gist_file>?lines=<number|ranges>`
`gist:[<username>/]<gist_id>#<gist_file>?highlights=<number|ranges>`
`gist:[<username>/]<gist_id>#<gist_file>?highlights=<number|ranges>&lines=<number|ranges>`
`gist:[<username>/]<gist_id>?file=<gist_file>`
`gist:[<username>/]<gist_id>?file=<gist_file>?lines=<number|ranges>`
`gist:[<username>/]<gist_id>?file=<gist_file>?highlights=<number|ranges>`
`gist:[<username>/]<gist_id>?file=<gist_file>?highlights=<number|ranges>&lines=<number|ranges>`
```

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

Highlights can be defined using:
- A single number (e.g. `highlights=1`)
- A list of numbers (e.g. `highlights=1,4`)
- A range of numbers (e.g. `highlights=1-4`)
- A combination of all above (e.g. `highlights=1,3,7-9`)
Highlights and lines can be defined using:
- A single number (e.g. `highlights=1`, `lines=1`)
- A list of numbers (e.g. `highlights=1,4`, `lines=1,4`)
- A range of numbers (e.g. `highlights=1-4`, `lines=1-4`)
- A combination of all above (e.g. `highlights=1,3,7-9`, `lines=1,3,7-9`)

## Installation

Expand Down
Loading

0 comments on commit c086c3a

Please sign in to comment.