Skip to content
CommonMark generator for Jekyll used by GitHub Pages
Ruby Shell
Branch: master
Clone or download

Latest commit

Latest commit fcd4e0b Jan 20, 2019

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib jekyll-commonmark is now processing the options in the initializer Jun 16, 2018
script Initial commit Jun 28, 2017
spec no square bracket in fn link Jan 20, 2019
.gitignore Initial commit Jun 28, 2017
.travis.yml recent ruby only Jan 20, 2019
Gemfile Initial commit Jun 28, 2017
LICENSE Initial commit Jun 28, 2017
README.md fixes typo and adds mention of other available extension Jul 11, 2018
Rakefile Initial commit Jun 28, 2017
appveyor.yml remove ruby 2.1 from appveyor Jan 21, 2019
jekyll-commonmark-ghpages.gemspec 💎 0.1.6 Jan 21, 2019

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", "table", "tagfilter"]
You can’t perform that action at this time.