README.md in jekyll-gist-1.3.5 vs README.md in jekyll-gist-1.4.0

- old
+ new

@@ -16,10 +16,17 @@ Or install it yourself as: $ gem install jekyll-gist +Finally, add the following to your site's `_config.yml`: + +``` +gems: + - jekyll-gist +``` + ## Usage Use the tag as follows in your Jekyll pages, posts and collections: ```liquid @@ -37,9 +44,20 @@ ```liquid {% gist parkr/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`: + +```yml +gist: + noscript: false +``` ## Contributing 1. Fork it ( https://github.com/jekyll/jekyll-gist/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`)