jekyll-commonmark-ghpages

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

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: ["UNSAFE", "SMART", "FOOTNOTES"]
  extensions: ["strikethrough", "autolink", "table", "tagfilter"]

⚠ The UNSAFE option is required for HTML rendering.