Skip to content

jekyll/jekyll-commonmark

Repository files navigation

jekyll-commonmark

CommonMark Markdown converter for Jekyll

Gem Version Build Status Windows Build status

Jekyll Markdown converter that uses libcmark-gfm (via commonmarker). As a result, it is faster than Kramdown.

GitHub Pages supports CommonMark through https://github.com/github/jekyll-commonmark-ghpages

Installation

Add the following to your Gemfile

group :jekyll_plugins do
  gem 'jekyll-commonmark'
end

and modify your _config.yml to use CommonMark as your Markdown converter

markdown: CommonMark

Configuration

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

commonmark:
  options: ["FOOTNOTES"]
  extensions: ["strikethrough", "autolink", "table"]