Skip to content

Instantly share code, notes, and snippets.

@jsejcksn
Last active August 29, 2015 14:07
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jsejcksn/91d2c026df75566c7ba1 to your computer and use it in GitHub Desktop.
Save jsejcksn/91d2c026df75566c7ba1 to your computer and use it in GitHub Desktop.
Markdown basics

#Markdown basics

The content in the grey blocks show the meaningful formatting that you'd use while writing your text content, and then below each block you can see what it would look like after being converted into HTML.

Table of Contents

Headers
Emphasis
Lists
Blockquotes
Horizontal Rules
Paragraphs

Headers

# H1
## H2
### H3
#### H4
##### H5
###### H6

H1

H2

H3

H4

H5
H6

Emphasis

Emphasis, aka italics, with *asterisks* or _underscores_.

Strong emphasis, aka bold, with **asterisks** or __underscores__.

Combined emphasis with **asterisks and _underscores_**.

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

It doesn't matter which one you choose, but keeping it consistent is helpful.

Lists

(In this example, leading and trailing spaces are shown with with dots: ⋅)

1. First ordered list item
2. Another item
⋅⋅* Unordered sub-list
3. Another item
⋅⋅1. Ordered sub-list
4. And another item

⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

⋅⋅⋅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.

* Unordered lists use asterisks
- Or minuses
  1. First ordered list item
  2. Another item
  • Unordered sub-list
  1. Another item

  2. Ordered sub-list

  3. And another item

    You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

    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.

  • Unordered lists use asterisks
  • Or minuses

Blockquotes

> Blockquotes are very handy in email to emulate reply text.
> This line is part of the same quote.
>
> Remember to add two newlines if you want a separate paragraph in the same quote.

Quote break.

> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.

Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Remember to add two newlines if you want a separate paragraph in the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.

Horizontal Rules

Three or more...

---

Hyphens

***

Asterisks

___

Underscores

Three or more...


Hyphens


Asterisks


Underscores

Paragraphs

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a *separate paragraph*.

This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the *same paragraph*.



Multiple newlines don't add any more space than two.

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the same paragraph.

Multiple newlines don't add any more space than two.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment