This gem extends the default kramdown parser with a new block-level
element which adds support for embedding GitHub Gists via
Javascript without having to hardcode <script> tags.
It has been designed with nanoc in mind, but it can be used with any other program which embeds kramdown (as long as it allows to override the parser being used.)
Add this line to your application's Gemfile:
gem 'kramdown-gist'
And then execute:
$ bundle
Or install it yourself as:
$ gem install kramdown-gist
If you're using nanoc, it's sufficient to require this gem from the
Rules file of your site and then pass { :input => 'KramdownGist' } as
options for any instance of the kramdown filter.
Example:
require 'kramdown-gist'
compile '*.md' do
filter :kramdown, { :input => 'KramdownGist' }
end
Usage with standalone kramdown is similar:
require 'kramdown'
require 'kramdown-gist'
Kramdown::Document.new(content, :input => 'KramdownGist').to_html
The extended parser class supports the same syntax as kramdown
with the addition of the *{gist:<id>} block-level element. The element
will be replaced with an appropriate <script> tag.
<id> should be replaced with the identifier of the Gist you wish to embed.
LaTeX output sucks, contributions are more than welcome.
- Fork
- Create a topic branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
GPLv3 — see COPYING for more information