Markdown Guide

Nearly all Markdown applications support the basic syntax outlined in John Gruber’s original design document. There are minor variations and discrepancies between Markdown processors — those are noted inline wherever possible.

Overview

Nearly all Markdown applications support the basic syntax outlined in John Gruber’s original design document. There are minor variations and discrepancies between Markdown processors — those are noted inline wherever possible.

Headings

Heading level 1

Heading level 2

Heading level 3

Heading level 4

Heading level 5
Heading level 6

Alternatively, on the line below the text, add any number of == characters for heading level 1 or – characters for heading level 2.

Heading level 1

Heading level 2

Markdown applications don’t agree on how to handle a missing space between the number signs (#) and the heading name. For compatibility, always put a space between the number signs and the heading name.
You should also put blank lines before and after a heading for compatibility.

Paragraphs

Don’t put tabs or spaces in front of your paragraphs.

Keep lines left-aligned like this.

To create paragraphs, use a blank line to separate one or more lines of text.
Unless the paragraph is in a list, don’t indent paragraphs with spaces or tabs.

Line Breaks

To create a line break (<br>), end a line with two or more spaces, and then type return. For compatibility, use trailing white space or the
HTML tag at the end of the line.

First line with the HTML tag after.

And the next line.

Emphasis

I just love bold text.
A cat meow
This is really very important text.

Blockquotes

Dorothy followed her through many of the beautiful rooms in her castle.

The quarterly results look great!

  • Revenue was off the chart.
  • Profits were higher than ever.

Everything is going according to plan.

Lists
  1. First item
  2. Second item
  3. Third item
  4. Fourth item
  • First item
  • Second item
  • Third item
  • Fourth item
  • First item
  • Second item
  • Third item
    • Indented item
    • Indented item
  • Fourth item
  • This is the first list item.

  • Here’s the second list item.

    I need to add another paragraph below the second list item.

  • And here’s the third list item.

  • This is the first list item.

  • Here’s the second list item.

    A blockquote would look great below the second list item.

  • And here’s the third list item.

Tux, the Linux mascot

  1. First item
  2. Second item
  3. Third item
    • Indented item
    • Indented item
  4. Fourth item
Code

At the command prompt, type nano.

Use `code` in your Markdown file.

Try to put a blank line before…


…and after a horizontal rule.

Links

My favorite search engine is Duck Duck Go.

My favorite search engine is Duck Duck Go.

https://www.markdownguide.org
fake@example.com

I love supporting the EFF.
This is the Markdown Guide.
See the section on code.

link

Images

The San Juan Mountains are beautiful!

An old rock in the desert

Escaping Characters

* Without the backslash, this would be a bullet in an unordered list.

Characters You Can Escape

Character Name
\ backslash
` backtick (see also escaping backticks in code)
* asterisk
_ underscore
{ } curly braces
[ ] brackets
< > angle brackets
( ) parentheses
# pound sign
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark
| pipe (see also escaping pipe in tables)
HTML

This word is bold. This word is italic.

For security reasons, not all Markdown applications support HTML in Markdown documents. When in doubt, check your Markdown application’s documentation. Some applications support only a subset of HTML tags.

Use blank lines to separate block-level HTML elements like <div>, <table>, <pre>, and <p> from the surrounding content. Try not to indent the tags with tabs or spaces — that can interfere with the formatting.

You can’t use Markdown syntax inside block-level HTML tags. For example, <p>italic and **bold**</p> won’t work.