CommonMark generator for Jekyll used by GitHub Pages
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
script
spec
.gitignore
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
appveyor.yml
jekyll-commonmark-ghpages.gemspec

README.md

jekyll-commonmark-ghpages

GitHub Flavored Markdown converter for Jekyll, based on jekyll-commonmark

Gem Version Build Status Windows Build status

Jekyll Markdown converter that uses libcmark-gfm, GitHub's fork of cmark, the reference parser for CommonMark, with some additions to ensure compatibility with existing Kramdown-based sites.

Installation

Add the following to your Gemfile:

group :jekyll_plugins do
  gem 'jekyll-commonmark-ghpages'
end

and modify your _config.yml to use CommonMarkGhPages as your Markdown converter:

markdown: CommonMarkGhPages

This processor is currently in testing for use in GitHub Pages.

To specify extensions and options for use in converting Markdown to HTML, supply options to the Markdown converter:

commonmark:
  options: ["SMART", "FOOTNOTES"]
  extensions: ["strikethrough", "autolink", "tables"]