Jekyll Commonmark Ghpages

Overview

The Jekyll CommonMark for GitHub Pages is a powerful tool designed for developers who want to convert Markdown into HTML using GitHub's flavor of the CommonMark specification. Built on the foundation of jekyll-commonmark, this gem leverages libcmark-gfm, ensuring that users benefit from GitHub's enhancements and compatibility features. This option is particularly useful for those aiming to maintain or migrate Kramdown-based sites with ease.

As it currently stands, this processor is undergoing testing for use in GitHub Pages. It provides flexibility and compatibility, allowing developers to specify various extensions and options for Markdown conversion to better fit their site needs. The installation process is straightforward, requiring simple adjustments to the Gemfile and the site's configuration file.

Features

• GitHub Flavored Markdown: Utilizes GitHub's version of CommonMark, adding enhancements to standard Markdown features for rich text formatting.
• Compatibility with Kramdown: Designed to maintain compatibility with existing Kramdown-based sites, easing migration and integration efforts.
• Custom Options: Users can specify custom extensions and options for Markdown conversion, allowing for tailored functionality in HTML output.
• UNSAFE Option: The UNSAFE option is included for users needing to render HTML, which is crucial for enhanced content display.
• Simple Installation: Easily integrates into Jekyll projects by modifying the Gemfile and configuration file, making setup quick and hassle-free.
• Built on libcmark-gfm: Ensures adherence to the CommonMark standard while incorporating GitHub-specific enhancements for optimal performance.