Skip to content

markdown-cheatsheet.md

Latest commit

 

History

History
159 lines (114 loc) · 3.88 KB

markdown-cheatsheet.md

File metadata and controls

159 lines (114 loc) · 3.88 KB
title Markdown Cheatsheet
layout blog-article
permalink /blog/markdown-cheatsheet/

Markdown markup language is allowed in comments. I encourage you to follow these guidelines since it's guaranteed the content will be rendered just fine.

Paragraphs

A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines.

For example: {% highlight none %} This is a paragraph.

This is another paragraph. {% endhighlight %}

Headers

Headers use 2-6 hash characters at the start of the line, corresponding to header levels 2-6 (h1 is reserved).

For example: {% highlight none %}

Header 2

Header 3

Header 6

{% endhighlight %}

Blockquotes

Markdown uses email-style > characters for blockquoting. You can hard wrap the text and put a > before every line, or be lazy and only put the > before the first line of a hard-wrapped paragraph.

For example: {% highlight none %}

This is a blockquote with two paragraphs.

Paragraph 2. {% endhighlight %}

Unordered lists

Unordered lists use asterisks, pluses, and hyphens — interchangably — as list markers.

For example: {% highlight none %}

  • Red
  • Green
  • Blue
  • Red
  • Green
  • Blue
  • Red
  • Green
  • Blue {% endhighlight %}

Ordered lists

Ordered lists use numbers followed by periods. You can backslash-escape the period to avoid triggering a list by accident.

For example: {% highlight none %}

  1. First element
  2. Second element
  3. Third element

1. This is not an ordered list element. {% endhighlight %}

Code snippets

To produce a code block, wrap your code between three backtick quotes (`). You can optionally specify the language after the opening three quotes.

For example: {% highlight none %}

fun greet() {
    println("Hello, world!")
}

{% endhighlight %}

To write inline code, wrap your code between backtick quotes (`).

For example: {% highlight none %} The greet method prints 'Hello, world!'. {% endhighlight %}

Horizontal rules

Horizontal rule tags (

) are produced by placing three or more hyphens, asterisks, or underscores on a line by themselves. If you wish, you may use spaces between the hyphens or asterisks.

For example: {% highlight none %} {% raw %}

{% endraw %} {% endhighlight %}

Links

A link is composed of a set of square brackets, containing the link text; immediately followed by a set of regular parentheses, containing the URL where the link points at (along with an optional title, surrounded in quotes).

For example: {% highlight none %} This is an example inline link. {% endhighlight %}

Automatic links

Markdown supports a shortcut style for creating “automatic” links for URLs and email addresses: simply surround the URL or email address with angle brackets.

For example: {% highlight none %} http://example.com/

address@example.com {% endhighlight %}

Images

The image syntax resembles the syntax for links. Images consist in a an exclamation mark (!); followed by a set of square brackets, containing the alt attribute text for the image; followed by a set of parentheses, containing the URL or path to the image, and an optional title attribute enclosed in double or single quotes.

For example: {% highlight none %} Alt text {% endhighlight %}

Emphasis

Markdown treats asterisks (*) and underscores (_) as indicators of emphasis. Text wrapped with one * or _ will be wrapped with an HTML tag (i.e. italics); double *’s or _’s will be wrapped with an HTML tag (i.e. bold). Strikethrough uses two tildes (~).

For example: {% highlight none %} Italics

Italics

Bold

Bold

Bold and italics

Bold and italics

Bold and italics

Bold and italics

Bold and italics

Bold and italics

Strikethrough {% endhighlight %}