Kramdown Cheat Sheet

From WikiOD

Here is the cheatsheat of Kramdown and basic guide on how to use Kramdown

Configuration[edit | edit source]

  • parse_block_html - process kramdown syntax inside blocks

  • parse_span_html - process kramdown syntax inside inlines

  • html_to_native - convert html elements to native elements

    {::options parse_block_html=“true” /}

For the GFM parser:

  • hard_wrap

http://kramdown.gettalong.org/parser/gfm.html

For jekyll (gh-pages)[edit | edit source]

# _config.yml
markdown: kramdown
kramdown:
  input: GFM

Footnotes (Kramdown)[edit | edit source]

This is some text.[^1]. Other text.[^footnote].

[^1]: Some *crazy* footnote definition.

Abbreviations (Kramdown)[edit | edit source]

This is some text not written in HTML but in another language!

*[another language]: It's called Markdown
*[HTML]: HyperTextMarkupLanguage

Classes and IDs (Kramdown)[edit | edit source]

A simple paragraph with an ID attribute.
{: #para-one}

> A blockquote with a title
{:title="The blockquote title"}
{: #myid}

* {:.cls} This item has the class "cls"

{:.ruby}
    Some code here

References[edit | edit source]

Credit:rstacruz