Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform. What you will learn: How the Markdown format makes styled collaborative editing easy.
If you already have a version of kramdown on your machine, make sure it's at least on version 1.5.0. If you've followed these steps so far you're now ready to use kramdown and Rouge within your Jekyll setup. By the way, if, like me, you're always getting errors doing anything with Rouge, remember it's called Rouge, not Rogue. Using Rouge with. Mdmath allows to use Visual Studio Code as a markdown editor capable of typesetting and rendering TeX math.K, In fact it now reuses the built in markdown viewer.
Below are examples of all available structural elements that can be used in a kramdown text. Sincethe kramdown syntax is a superset of the Markdown syntax, only a small part of the available syntaxis not available in standard Markdown syntax. Note, that only the most basic syntax information isgiven. However, a link to the detailed syntax for each element is provided (which also details thedifferences to the standard Markdown syntax). The quick reference is for version <%=::Kramdown::VERSION %> of the syntax documentation.
kramdown has two main classes of elements: block and span-level elements. Block-level elements areused to create paragraphs, headers, lists and so on whereas span-level elements are used to markuptext phrases as emphasized, as a link and so on.
All examples below feature the kramdown source, the converted HTML source (shown when hovering overthe kramdown source) and the output as it appears in the browser. This looks like this:
Paragraphs
{kdlink: {oid: paragraphs, part: 'paragraphs'}}
Consecutive lines of text are considered to be one paragraph. As with other block level elements youhave to add a blank line to separate it from the following block-level element:
{kdexample::}The first paragraph.
Another paragraph{kdexample}
Explicit line breaks in a paragraph can be made by using two spaces or two backslashes at the end of a line:
{kdexample::}This is a paragraph
which contains a hard line break.{kdexample}
Headers
{kdlink: {oid: headers, part: 'headers'}}
kramdown supports Setext style headers and atx style headers. A header must always be preceded by ablank line except at the beginning of the document:
Second level header
{kdexample}
{kdexample::}
H2 header
H3 header
H4 header
H5 header
H6 header
{kdexample}
If you set the option auto_ids to false (for example, by using the options extension, seeExtensions), then the automatic header ID generation is turned off:
{kdexample::}{::options auto_ids='false' /}
{kdexample}
Blockquotes
{kdlink: {oid: blockquotes, part: 'blockquotes'}}
A blockquote is started using the > marker followed by an optional space; all following lines thatare also started with the blockquote marker belong to the blockquote. You can use any block-levelelements inside a blockquote:
{kdexample::}
A sample blockquote.
Nested blockquotes arealso possible.
Headers work too
This is the outer quote again.{kdexample}
You may also be lazy with the > markers as long as there is no blank line:
{kdexample::}
This is a blockquotecontinued on thisand this line.
But this is a separate paragraph.{kdexample}
Code Blocks
{kdlink: {oid: code-blocks, part: 'code blocks'}}
kramdown supports two different code block styles. One uses lines indented with either four spacesor one tab whereas the other uses lines with tilde characters as delimiters -- therefore the contentdoes not need to be indented:
{kdexample::}This is a sample code block.
{kdexample}
{kdexample::}
{kdexample}
The following is a code block with a language specified:
{kdexample::}
{kdexample}
Horizontal Rules
{kdlink: {oid: horizontal-rules, part: 'horizontal rules'}}
It is easy to insert a horizontal rule in kramdown: just use three or more asterisks, dashes orunderscores, optionally separated by spaces or tabs, on an otherwise blank line:
{kdexample::}
---
{kdexample}
Lists
{kdlink: {oid: lists, part: 'lists'}}
kramdown supports ordered and unordered lists. Ordered lists are started by using a number followedby a period, a space and then the list item text. The content of a list item consists of block-levelelements. All lines which have the same indent as the text of the line with the list marker belongto the list item:
{kdexample::}
- This is a list item
- And another item
- And the third onewith additional text{kdexample}
As with block quotes, you may be lazy when using the list item marker:
{kdexample::}
- A list itemwith additional text{kdexample}
As the content consists of block-level elements you can do things like the following:
{kdexample::}
This is a list item
with a blockquote
Followed by another item{kdexample}
Nested lists are also easy to create:
{kdexample::}
- Item one
- sub item one
- sub item two
- sub item three
- Item two{kdexample}
Lists can occur directly after other block-level elements, however, there has to be at least oneblank line if you want to follow a paragraph with a list:
{kdexample::}This is a paragraph.
This is NOT a list.
This is a list!{kdexample}
Unordered lists are started by using an asterisk, a dash or a plus sign (they can be mixed) and aspace. Apart from that unordered lists follow the same rules as ordered lists:
{kdexample::}
- Item one
- Item two
- Item three{kdexample}
Definition Lists
{kdlink: {oid: definition-lists, part: 'definition lists'}}
A definition list works similar to a normal list and is used to associate definitions with terms.Definition lists are started when a normal paragraph is followed by a line starting with a colon andthen the definition text. One term can have many definitions and multiple terms can have the samedefinition. Each line of the preceding paragraph is assumed to contain one term, for example:
{kdexample::}term: definition: another definition
another termand another term: and a definition for the term{kdexample}
If you insert a blank line before a definition (note: there must only be one blank line between theterms and the first definition), the definition will be wrapped in a paragraph:
{kdexample::}term
: definition: definition{kdexample}
Each term can be styled using span-level elements and each definition is parsed as block-levelelements, i.e. you can use any block-level in a definition. Just use the same indent for the linesfollowing the definition line:
{kdexample::}This is a term
: This will be a para
a blockquote
{kdexample}
Tables
{kdlink: {oid: tables, part: 'tables'}}
kramdown supports a syntax for creating simple tables. A line starting with a pipe character (|)starts a table row. However, if the pipe characters is immediately followed by a dash (-), aseparator line is created. Separator lines are used to split the table header from the table body(and optionally align the table columns) and to split the table body into multiple parts. If thepipe character is followed by an equal sign (=), the tables rows below it are part of the tablefooter.
{kdexample::}| A simple | table || with multiple | lines|{kdexample}
{kdexample::}
| Header1 | Header2 | Header3 |
|---|---|---|
| cell1 | cell2 | cell3 |
| cell4 | cell5 | cell6 |
| ---- | ||
| cell1 | cell2 | cell3 |
| cell4 | cell5 | cell6 |
| Foot1 | Foot2 | Foot3 |
| {: rules='groups'} | ||
| {kdexample} |
HTML elements
{kdlink: {oid: html-blocks, part: 'HTML blocks'}}
kramdown allows you to use block-level HTML tags (div, p, pre, ..) to markup whole blocks oftext -- just start a line with a block-level HTML tag. kramdown syntax is normally not processedinside an HTML tag but this can be changed with the parse_block_html option. If this options isset to true, then the content of a block-level HTML tag is parsed by kramdown either as blocklevel or span-level text, depending on the tag:
{kdexample::}
{::options parse_block_html='true' /}
This can contain only *span* level elements.
{kdexample}Block Attributes
{kdlink: {oid: block-ials, part: 'block IALs'}}{kdlink: {oid: attribute-list-definitions, part: 'ALDs'}}
You can assign any attribute to a block-level element. Just directly follow the block with a blockinline attribute list (or short: block IAL). A block IAL consists of a left curly brace, followedby a colon, the attribute definitions and a right curly brace. Here is a simple example which sets thetitle attribute of a block quote:
{kdexample::}
Plays a transient click through the iPhone’s audio outputs. Designed for speaker time alignment. The AudioToolbox framework provides interfaces for recording, playback, and stream parsing. In iOS, the framework provides additional interfaces for managing audio sessions. Audio Toolbox™ provides tools for audio processing, speech analysis, and acoustic measurement. It includes algorithms for processing audio signals such as equalization and time stretching, estimating acoustic signal metrics such as loudness and sharpness. The audio toolbox.
A nice blockquote{:}{kdexample}
As one often wants to set one or more CSS classes on an element, there is an easy shortcut:
{kdexample::}
A nice blockquote{: .class1 .class2}{kdexample}
A shortcut for setting the ID is also provided. Just prefix the ID with a hash symbol:
{kdexample::}
A nice blockquote{: #with-an-id}{kdexample}
Sometimes one wants to use the same attributes for many elements. kramdown allows you to define theattributes in one place with an attribute list definition (or short: ALD) and just reference thisdefinition in a block IAL. An ALD has the same structure as a block IAL but the colon has to bereplace with a colon, the reference name and another colon. By just using the reference name as-isin a block IAL, one can include the attributes of the referenced ALD:
{kdexample::}{:refdef: .c1 #id .c2}paragraph{: refdef}{kdexample}
The order in a block IAL or ALD is important because later defined attributes overwrite (with theexception of the shortcut for CSS classes) prior defined attributes:
{kdexample::}{:refdef: .c1 #id .c2}paragraph{: refdef .c3 #para}{kdexample}
Extensions
{kdlink: {oid: extensions, part: 'extensions'}}
kramdown provides some less used functionality through a common syntax. This will allow the easyaddition of other extensions if need arises. Currently, there are extensions for ignoring text (i.e.treating text as comment), for inserting arbitrary text as-is into the output and for settingkramdown options.
Here is an example that shows how to insert comments into text:
{kdexample::}This is a paragraph{::comment}This is a comment which iscompletely ignored.{:/comment}.. paragraph continues here.
Extensions can also be usedinline {::nomarkdown}see{:/}!{kdexample}
As one can see from the above example, the syntax for extensions is nearly identical to that ofALDs. However, there is no trailing colon after the extension name and the extension end tag needs aslash between the colon and the extension name. One can also use the short form of the end tag, i.e.{:/}. Attribute definitions can be specified on the start tag by separating them with a space fromthe extension name. Also, if the extension does not have a body, there needs to be a slash rightbefore the closing brace:
{kdexample::}{::options auto_ids='false' /}
{kdexample}
Emphasis
{kdlink: {oid: emphasis, part: 'emphasis'}}
Emphasis can be added to text by surrounding the text with either asterisks or underscores:
{kdexample::}This is emphasized,this too!{kdexample}
Strong emphasis can be done by doubling the delimiters:
{kdexample::}This is strong,this too!{kdexample}
The form with the asterisks can also be used to markup parts of words:
{kdexample::}This works as expected!{kdexample}
Links and Images
{kdlink: {oid: links-and-images, part: 'links and images'}}
A simple link can be created by surrounding the text with square brackets and the link URL withparentheses:
{kdexample::}A linkto the kramdown homepage.{kdexample}
You can also add title information to the link:
{kdexample::}A linkto the homepage.{kdexample} Best free antivirus for mac 2020 with free trials.
There is another way to create links which does not interrupt the text flow. The URL and title aredefined using a reference name and this reference name is then used in square brackets instead ofthe link URL:
{kdexample::}A linkto the homepage.
{kdexample}
If the link text itself is the reference name, the second set of square brackets can be omitted:
{kdexample::}A link to the kramdown hp.
{kdexample}
Images can be created in a similar way: just use an exclamation mark before the square brackets. Thelink text will become the alternative text of the image and the link URL specifies the image source:
{kdexample::}An image: {kdexample}
Inline Code
{kdlink: {oid: code-spans, part: 'code spans'}}
Text phrases can be easily marked up as code by surrounding them with backticks:
{kdexample::}Use Kramdown::Document.new(text).to_htmlto convert the text in kramdownsyntax to HTML.{kdexample}
If you want to use literal backticks in your code, just use two or more backticks as delimiters. Thespace right after the beginning delimiter and the one right before the closing delimiter are ignore:
{kdexample::}Use backticks to markup code,e.g. `code`.{kdexample}
Footnotes
{kdlink: {oid: footnotes, part: 'footnotes'}}
Footnotes can easily be used in kramdown. Just set a footnote marker (consists of square bracketswith a caret and the footnote name inside) in the text and somewhere else the footnote definition (whichbasically looks like a reference link definition):
{kdexample::}This is a text with afootnote[^1].
[^1]: And here is the definition.{kdexample}
Kramdown List
The footnote definition can contain any block-level element, all lines following a footnotedefinition indented with four spaces or one tab belong to the definition:
{kdexample::}This is a text with afootnote[^2].
[^2]:And here is the definition.
Kramdown Class
{kdexample}
As can be seen above the footnote name is only used for the anchors and the numbering is doneautomatically in document order. Repeated footnote markers will link to the same footnotedefinition.
Abbreviations
{kdlink: {oid: abbreviations, part: 'abbreviations'}}
Abbreviations will work out of the box once you add an abbreviation definition. So you can justwrite the text and add the definitions later on.
{kdexample::}This is an HTMLexample.
Kramdown
*[HTML]: Hyper Text Markup Language{kdexample}
HTML Elements
{kdlink: {oid: html-spans, part: 'HTML spans'}}
HTML is not only supported on the block-level but also on the span-level:
{kdexample::}This is written inred.{kdexample}
Kramdown Editor
Inline Attributes
{kdlink: {oid: span-ials, part: 'span IALs'}}
Kramdown
As with a block-level element you can assign any attribute to a span-level elements using a spaninline attribute list (or short: span IAL). A span IAL has the same syntax as a block IAL and mustimmediately follow the span-level element:
Kramdown Toc
{kdexample::}This is red{:}.{kdexample}