GitHub Pages with GitHub Flavored Markdown, footnotes and syntax highlighting simplified

in webdevelopment | feedback

Another update regarding the use of GitHub Flavored Markdown on GitHub Pages. GitHub Pages has updated it’s Jekyll version to 3.0 on the first of February 2016.
This update includes a switch to kramdown as its Markdown parser as well as only supporting Rouge as syntax highlighter. This means we’re effectively back to the original setup from 2013 but because all of these components have received some updates in the meantime everything is now supported out of the box.

Support for other Markdown engines like Redcarpet and RDiscount was consecutively dropped from GitHub Pages on the second of May 2016.
Some more information on this decision can be found in this blogpost.

Configuration #

For basic functionality, including parsing of GitHub Flavored Markdown and support for footnotes and syntax highlighting using fenced code blocks no configuration is necessary.
GitHub already takes care of all of this with its default configuration.

Customization #

Any of the configuration options in the defaults you can change section can be configured to your liking.
Personally I prefer GitHub Flavored Markdown’s way of handling line breaks so I added the following to my configuration:

kramdown:
  hard_wrap: true