My quick reference to the most commom MD. These examples are not pegged to Github markdown, instead I tried to cover what should be supported on all platforms.

Block Elements

We would like to show you a description here but the site won’t allow us. ⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical Github Flavored Markdown line break behaviour, where trailing spaces are not required.). Dev.to uses markdown for its blog posts. I use markdown to take notes. Github uses markdown in Gists, Pull Requests, Issues and README files. In this cheat-sheet, I have selected the most used markdown syntax. 📁 Download the pdf version of this cheatsheet 🌟 All my cheat-sheets are in this repo (Star it!). GitHub Cheatsheet Markdown Cheatsheet Glossary Course template explained How to use Google Analytics Resources SAPUI5 SDK Next module: feedback Markdown Cheatsheet. The idea for Markdown is to make it easy to read, write, and edit prose. HTML is a.publishing. format; Markdown is a.writing. format. Thus, Markdown's formatting syntax only addresses issues that can be conveyed in plain text. For any markup that is not covered by Markdown.

Paragraphs & Breaks

To create a paragraph, simply create a block of text that is not separated by one or more blank lines. Blocks of text separated by one or more blank lines will be parsed as paragraphs.

If you want to create a line break, end a line with two or more spaces, then hit Return/Enter.

MD(dots are spaces in your MD):

Results:

This is a paragraph
This is just a continuing line of textThis is also just a continuing line of text

Headers

Markdown supports two header formats. The wiki editor uses the “atx’-style headers. Simply prefix your header text with the number of # characters to specify heading depth. For example: # H1, ## H2 and ### H3 will be progressively smaller headers, down to ###### H6.

MD:

Results:

H2

H3

H4

H5
H6

Blockquotes

Markdown creates blockquotes email-style by prefixing each line with the >. This looks best if you decide to hard-wrap text and prefix each line with a > character, but Markdown supports just putting > before your paragraph.

MD(dots are spaces in your MD):

Results:

This is a paragraph in a blockquote
This is just a lineI am also just a line

Lists

Markdown supports both ordered and unordered lists. To create an ordered list, simply prefix each line with a number (any number will do — this is why the editor only uses one number.) To create an unordered list, you can prefix each line with *, + or -.

MD:

Results:

  1. Apples
  2. Oranges
  • Potatoes
  • Carrots

List items can contain multiple paragraphs, however each paragraph must be indented by at least 4 spaces or a tab.

MD:

Results:

  1. Tree
    • Apples
    • Oranges
  2. Root
    • Potatoes
    • Carrots

Code Blocks

Markdown wraps code blocks in pre-formatted tags to preserve indentation in your code blocks. To create a code block, indent the entire block by at least 4 spaces or one tab. Markdown will strip the extra indentation you’ve added to the code block.

MD(dots are spaces in your MD):

Results:

Horizontal Rules

Horizontal rules are created by placing three or more hyphens, asterisks or underscores on a line by themselves. Spaces are allowed between the hyphens, asterisks or underscores.

MD:

Results:

Span Elements

Links

Markdown has two types of links: inline and reference. For both types of links, the text you want to display to the user is placed in square brackets. For example, if you want your link to display the text “GitHub”, you write [GitHub].

To create an inline link, create a set of parentheses immediately after the brackets and write your URL within the parentheses. (e.g., GitHub). Relative paths are allowed in inline links.

MD:

Results:

Emphasis

Asterisks (*) and underscores (_) are treated as emphasis and are wrapped with an tag, which usually displays as italics in most browsers. Double asterisks (**) or double underscores (__) are treated as bold using the tag. To create italic or bold text, simply wrap your words in single/double asterisks/underscores. For example, My double emphasis text becomes My double emphasis text, and My single emphasis text becomes My single emphasis text.

MD:

Results:

italicsstrongitalicsstrong

Code

To create inline spans of code, simply wrap the code in backticks (`). Markdown will turn myFunction into myFunction.

MD:

Results:

ReactDOM.render(<Button />, document.getElementById('container'))

Images

Markdown image syntax looks a lot like the syntax for links; it is essentially the same syntax preceded by an exclamation point (!). For example, if you want to link to an image at https://github.com/unicorn.png with the alternate text My Unicorn, you would write ![My Unicorn](https://github.com/unicorn.png).

MD:

Results:

Miscallaneous

Automatic Links

If you want to create a link that displays the actual URL, markdown allows you to quickly wrap the URL in < and > to do so. For example, the link https://github.com/ is easily produced by writing <https://github.com/>.

MD:

Results:

Escaping

If you want to use a special Markdown character in your document (such as displaying literal asterisks), you can escape the character with the backslash (). Markdown will ignore the character directly after a backslash.

MD:

Results:

_italics_ _strong_

Please enable JavaScript to view the comments powered by Disqus.blog comments powered by Disqus

Typography Elements in One

Let’s start with a informative paragraph. This text is bolded. But not this one! How about italic text? Cool right? Ok, let’s combine them together. Yeah, that’s right! I have code to highlight, so ThisIsMyCode(). What a nice! Good people will hyperlink away, so here we go or http://www.example.com.

Headings H1 to H6

H2 Heading

H3 Heading

H4 Heading

H5 Heading
H6 Heading

Footnote

Let’s say you have text that you want to refer with a footnote, you can do that too! This is an example for the footnote number one [1]. You can even add more footnotes, with link! [2]

Blockquote

Start by doing what’s necessary; then do what’s possible; and suddenly you are doing the impossible. –Francis of Assisi

NOTE: This theme does NOT support nested blockquotes.

List Items

  1. First order list item
  2. Second item
  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

Code Blocks

Table

Table 1: With Alignment

Github Markup Cheat Sheet

The cheat sheet website
TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1

Table 2: With Typography Elements

Markdown Cheat Sheet Github Free

MarkdownLessPretty
Stillrendersnicely
123

Horizontal Line

Github Markdown Guide

The HTML <hr> element is for creating a “thematic break” between paragraph-level elements. In markdown, you can create a <hr> with any of the following:

  • ___: three consecutive underscores
  • ---: three consecutive dashes
  • ***: three consecutive asterisks

Github Markdown Cheat Sheet Color

renders to:

Media

YouTube Embedded Iframe

Github Markdown Cheat Sheet Pdf

Image

Footnote:

  1. 1: Footnote number one yeah baby! ↩

  2. 2: A footnote you can link to - click here!↩