1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
|
# jekyll-commonmark
*CommonMark Markdown converter for Jekyll*
[](https://rubygems.org/gems/jekyll-commonmark)
[](https://travis-ci.org/jekyll/jekyll-commonmark)
[](https://ci.appveyor.com/project/pathawks/jekyll-commonmark)
Jekyll Markdown converter that uses [libcmark-gfm](https://github.com/github/cmark-gfm) (via [commonmarker](https://github.com/gjtorikian/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`
```ruby
group :jekyll_plugins do
gem 'jekyll-commonmark'
end
```
and modify your `_config.yml` to use **CommonMark** as your Markdown converter
```yaml
markdown: CommonMark
```
## Configuration
To specify [extensions](https://github.com/gjtorikian/commonmarker#extensions) and [options](https://github.com/gjtorikian/commonmarker#options) for use in converting Markdown to HTML, supply options to the Markdown converter:
```yaml
commonmark:
options: ["SMART", "FOOTNOTES"]
extensions: ["strikethrough", "autolink", "table"]
```
|