https://github.com/jekyll/jekyll-commonmark

CommonMark generator for Jekyll
https://github.com/jekyll/jekyll-commonmark

commonmark gem jekyll jekyll-plugin markdown-converter

Last synced: about 2 months ago
JSON representation

CommonMark generator for Jekyll

• Host: GitHub
• URL: https://github.com/jekyll/jekyll-commonmark
• Owner: jekyll
• License: mit
• Created: 2015-12-22T00:17:31.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-09-21T09:07:25.000Z (12 months ago)
• Last Synced: 2024-03-25T12:07:54.514Z (6 months ago)
• Topics: commonmark, gem, jekyll, jekyll-plugin, markdown-converter
• Language: Ruby
• Size: 112 KB
• Stars: 33
• Watchers: 7
• Forks: 17
• Open Issues: 2
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.markdown
  • License: LICENSE

Awesome Lists containing this project

• awesome-jekyll-plugins - **Commonmark** - commonmark](https://rubygems.org/gems/jekyll-commonmark) -- Markdown converter that uses libcmark, the reference parser for CommonMark. (Markup & Markdown Converters)

README

        
# jekyll-commonmark

*CommonMark Markdown converter for Jekyll*

[![Gem Version](https://img.shields.io/gem/v/jekyll-commonmark.svg)](https://rubygems.org/gems/jekyll-commonmark)

[![Build Status](https://img.shields.io/travis/jekyll/jekyll-commonmark/master.svg)](https://travis-ci.org/jekyll/jekyll-commonmark)

[![Windows Build status](https://img.shields.io/appveyor/ci/pathawks/jekyll-commonmark/master.svg?label=Windows%20build)](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: ["FOOTNOTES"]

  extensions: ["strikethrough", "autolink", "table"]

```