Load GitHub Gists asynchronously and optionally specify which file to show. This allows you to keep related files in a single gist, but show them individually on your pages. The async loading prevents your page rendering from stalling.
Based on Mark Selby's [async-gists.js]. [async-gists.js]: https://gist.github.com/markselby/7209751
Requires jQuery.
Include javascripts/main.coffee however you like
or load the compiled file js/gist-async.min.js,
then call the global function, e.g.,
(function (window, document) {
document.addEventListener('DOMContentLoaded', function () {
window.gistAsync();
})
})(window, document);Example markup:
<div class="gist" data-gist="8288761" data-gist-file="gist-async.coffee">
<a href="https://gist.github.com/8288761">Loading file gist-async.coffee from 8288761</a>
</div>The minimal required markup is
<div data-gist="8288761"></div>- Jekyll plugin that modifies the gist markup added by its gist Liquid tag.
- WordPress shortcode by timrourke.
The recommended method is to add this as a dependency to your project using npm with
$ npm install --save gist-async
or Bower with
$ bower install --save gist-async
Alternatively, you can download a release or clone the repository directly.
The gist-async source is hosted on GitHub. Clone the project with
$ git clone https://github.com/razor-x/gist-async.git
You will need Node.js with npm.
Install the development dependencies with
$ npm install
Install any Bower dependencies and have Grunt watch for changes with
$ npm start
Optionally, you may run additional development tasks with Grunt. Install it with
$ npm install --global grunt-cli
Run $ grunt --help to see all Grunt tasks.
coffeelint # Validate files with CoffeeLint *
clean # Clean files and folders. *
coffee # Compile CoffeeScript files into JavaScript *
watch # Run predefined tasks whenever watched files change.
default # Alias for "clean", "coffeelint", "coffee" tasks.
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/razor-x/gist-async/fork).
- Create your feature branch (
git checkout -b my-new-feature). - Make changes.
- Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create a new Pull Request.
This CoffeeScript package is licensed under the MIT license.
This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.