0.0
The project is in a healthy, maintained state
CommonMark generator for Jekyll
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

>= 4.0
>= 0.17
>= 3.0
 Project Readme

Jekyll::Markly

Jekyll Markdown converter that uses cmark-gfm, Github's fork of the reference parser for CommonMark, through the markly gem.

Installation

Add jekyll-markly to the jekyll_plugins group in your Gemfile

group :jekyll_plugins do
  gem "jekyll-markly"
end

and update the markdown configuration in _config.yml

markdown: Markly

Configuration

cmark-cfm extensions and options can be configured with the commonmark configuration in _config.yml

commonmark:
  extensions: [table, strikethrough, autolink]
  options: [unsafe, footnotes]

The full list of supported extensions and options can be found in the Markly documentation.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/skipkayhil/jekyll-markly.

License

The gem is available as open source under the terms of the MIT License.