Markdown Resources

Instant Markdown

Markdown Cheatsheet

Pandoc Commands

Pandoc: a universal document converter

Markdown Syntax

Cited from Markdown Tutorial

Italic and Bold

To make a phrase italic in Markdown, the words can be surrounded by underscores ("_"), such as "_italic_".

To make phrases bold in Markdown, the words can be surrounded with two asterisks ("**"), such as "**bold**".

Headers

There are six types of headers, in decreasing sizes. The same number of hash marks before a header specified the size of the header in decreasing size.

 A header can not be made bold, but certain words can be italicized.

Links to Websites

To create an inline link, the link text is wrapped in brackets "[ ]", and then you wrap the link in parenthesis "( )". For example, "[Visit GitHub!](www.github.com)".

The reference link is a reference to another place in the document. For example, "[text][reference]" in the text, and at the bottom of the markdown document "[reference]:url".

Images

To create an inline image, "!(alt text)[url]".

Blockquote

A blockquote is a sentence or paragraph that's been specially formatted to draw attention to the reader.

To create a block quote, preface a paragraph or several paragraphs can be prefaced with the "greater than" caret (>).

Lists

To create an unordered list, each item in the list must be prefaced with an asterisk and space ("* "). Each item must be listed in its own line.

An ordered list is prefaced with numbers, instead of asterisks.

With a nested list, the sub-item must be indented one space more compared to the preceding item.

Graphs

If a new line was forcefully inserted, the togetherness may be broken. This would be the case of a hard break. Two spaces after each new line may be inserted to create a soft break.