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

CommonMark generator for Jekyll used by GitHub Pages
https://github.com/github/jekyll-commonmark-ghpages

Last synced: 10 months ago
JSON representation

CommonMark generator for Jekyll used by GitHub Pages

• Host: GitHub
• URL: https://github.com/github/jekyll-commonmark-ghpages
• Owner: github
• License: mit
• Created: 2017-06-28T05:27:44.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-05-05T17:00:10.000Z (10 months ago)
• Last Synced: 2025-05-05T18:24:13.864Z (10 months ago)
• Language: Ruby
• Homepage:
• Size: 120 KB
• Stars: 66
• Watchers: 125
• Forks: 19
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# jekyll-commonmark-ghpages

*GitHub Flavored Markdown converter for Jekyll, based on [`jekyll-commonmark`](https://github.com/jekyll/jekyll-commonmark)*

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

[![Build Status](https://github.com/github/jekyll-commonmark-ghpages/actions/workflows/cibuild.yaml/badge.svg)](https://github.com/github/jekyll-commonmark-ghpages/actions/workflows/cibuild.yaml)

Jekyll Markdown converter that uses [libcmark-gfm](https://github.com/github/cmark), GitHub's fork of [cmark](https://github.com/commonmark/cmark), the reference parser for CommonMark, with some additions to ensure compatibility with existing Kramdown-based sites.

## Installation

Add the following to your `Gemfile`:

```ruby

group :jekyll_plugins do

  gem 'jekyll-commonmark-ghpages'

end

```

and modify your `_config.yml` to use **CommonMarkGhPages** as your Markdown converter:

```yaml

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:

```yaml

commonmark:

  options: ["UNSAFE", "SMART", "FOOTNOTES"]

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

```

⚠ The `UNSAFE` option is required for HTML rendering.