README.md in jekyll-gist-1.4.1 vs README.md in jekyll-gist-1.5.0

- old
+ new

@@ -6,33 +6,35 @@ ## Installation Add this line to your application's Gemfile: - gem 'jekyll-gist' + $ gem 'jekyll-gist' And then execute: $ bundle Or install it yourself as: $ gem install jekyll-gist -Finally, add the following to your site's `_config.yml`: +Then add the following to your site's `_config.yml`: ``` -gems: +plugins: - jekyll-gist ``` +💡 If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`. + ## Usage Use the tag as follows in your Jekyll pages, posts and collections: ```liquid -{% gist parkr/c08ee0f2726fd0e3909d %} +{% gist c08ee0f2726fd0e3909d %} ``` This will create the associated script tag: ```html @@ -40,19 +42,19 @@ ``` You may optionally specify a `filename` after the `gist_id`: ```liquid -{% gist parkr/c08ee0f2726fd0e3909d test.md %} +{% gist c08ee0f2726fd0e3909d test.md %} ``` This will produce the correct URL to show just the specified file in your post rather than the entire Gist. **Pro-tip**: If you provide a personal access token with Gist scope, as the environmental variable `JEKYLL_GITHUB_TOKEN`, Jekyll Gist will use the Gist API to speed up site generation. ## Disabling `noscript` support -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`: +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`: ```yml gist: noscript: false ```