Skip to content

Commit 0c7b356

Browse files
committed
Docs: update README
fix #51
1 parent 1c0313a commit 0c7b356

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Liquid tag for displaying GitHub Gists in Jekyll sites: `{% gist %}`.
88

99
Add this line to your application's Gemfile:
1010

11-
gem 'jekyll-gist'
11+
$ gem 'jekyll-gist'
1212

1313
And then execute:
1414

@@ -18,13 +18,15 @@ Or install it yourself as:
1818

1919
$ gem install jekyll-gist
2020

21-
Finally, add the following to your site's `_config.yml`:
21+
Then add the following to your site's `_config.yml`:
2222

2323
```
2424
plugins:
2525
- jekyll-gist
2626
```
2727

28+
💡 If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
29+
2830
## Usage
2931

3032
Use the tag as follows in your Jekyll pages, posts and collections:
@@ -51,7 +53,7 @@ This will produce the correct URL to show just the specified file in your post r
5153

5254
## Disabling `noscript` support
5355

54-
By default, Jekyll Gist will make an HTTP call per Gist to retrieve the raw content of the Gist. This information is used to propagate `noscript` tags for search engines and browsers without Javascript support. If you'd like to disable this feature, for example, to speed up builds locally, simply add the following to your site's `_config.yml`:
56+
By default, Jekyll Gist will make an HTTP call per Gist to retrieve the raw content of the Gist. This information is used to propagate `noscript` tags for search engines and browsers without Javascript support. If you'd like to disable this feature, for example, to speed up builds locally, add the following to your site's `_config.yml`:
5557

5658
```yml
5759
gist:

0 commit comments

Comments
 (0)