This parser can parse “Github Flavored Markdown”. This is a format of Markdown that is used on Github.com for most places where textual input is required, such as issues and comments. Some of the extensions, notably the “backtick fenced code blocks” are also used on other sites, for example StackOverflow.
At the moment this parser is based on the kramdown parser, with the following changes:
- Support for fenced code blocks using three or more backticks has been added.
- Hard line breaks in paragraphs are enforced by default (see option ‘hard_wrap’).
- ATX headers need a whitespace character after the hash signs.
- Strikethroughs can be created using two tildes surrounding a piece of text
- Blank lines between paragraphs and other block elements are not needed by default (see option
Please note that the GFM parser tries to mimic the parser used at Github which means that for some special cases broken behaviour is the expected behaviour.
Here is an example:
This ~~is a complex strike through *test ~~with nesting~~ involved* here~~.
In this case the correct GFM result is:
<p>This <del>is a complex strike through *test ~~with nesting</del> involved* here~~.</p>
The GFM parser supports the following options:
- Interprets line breaks literally
<br />tags inside paragraphs where the original Markdown document had newlines (by default, Markdown ignores these newlines).
Used by: GFM parser
- Enables a set of GFM specific quirks
The way how GFM is transformed on Github often differs from the way kramdown does things. Many of these differences are negligible but others are not.
This option allows one to enable/disable certain GFM quirks, i.e. ways in which GFM parsing differs from kramdown parsing.
The value has to be a list of quirk names that should be enabled, separated by commas. Possible names are:
Disables the kramdown restriction that at least one blank line has to be used after a paragraph before a new block element can be started.
Note that if this quirk is used, lazy line wrapping does not fully work anymore!
Disables automatic conversion of some characters into their corresponding typographic symbols (like
--to em-dash etc). This helps to achieve results closer to what GitHub Flavored Markdown produces.
Used by: GFM parser