Documentation‎ > ‎

Markdown QuickReference

This is a short overview of the Markdown syntax. You can find a much more detailed description of Markdown and its syntax on the the official website.

Convention:
  • fixed font size is used for Markdown syntax
  • spaces that are part of the syntax are indicated by   
  • the corresponding output is shown next to or below the command

Formatting


*italic* or _italic_ italic
**bold** bold

Paragraphs


Paragraphs are separated

by an empty line

Paragraphs are separated

by an empty line


A line break is achieved by two  
spaces at the end of a line.

A line break is achieved by two  
spaces at the end of a line.

Headings


Heading 1
===

Heading 2
---

Heading 1

Heading 2

or

# Heading 1 #
## Heading 2 ##
### Heading 3 ###

Heading 1

Heading 2

Heading 3


Lists


Unordered Lists

Each item in a list is preceded by a *,- or + and a white space:

- Item 1
* Item 2
+ Item 3

  • Item 1
  • Item 2
  • Item 3

Ordered Lists

Items in an ordered lists begin with a number followed by a period and a white space. The numbers don't need to be continuous, but the resulting list will contain continuous numbers:

1. Item 1
5. Item 2
10. Item 3

  1. Item 1
  2. Item 2
  3. Item 3

Multiple line items

To have multiple line items, add a line break at the end of the first line and precede the next line with a white space (this way, you can also generate nested lists)

- Item 1  
 still item 1
- Item 2

  • Item 1
    still item 1
  • Item 2

Links


Links have the form [text](URL):

[FloatNotes](https://addons.mozilla.org/en-US/firefox/addon/179549/)


Or just

<https://addons.mozilla.org/en-US/firefox/addon/179549/>


Images

You can embed images similar the same way you use links, but with a preceding exclamation mark:
![alternative text (can be empty)](URL)

![Firefox Addons](https://addons.mozilla.org/media//img/amo2009/app-icons/firefox.png)

Firefox Addons

Code

For developers, code can be either as block or inline. Inline code needs to be enclosed in backticks `: `this is inline code`.
Code blocks are generated by indentation with four spaces and a preceding and following empty line:

Some text

    here starts
    some code

More text


HTML

You can add any other HTML you like, like tables.
Comments

Get Help

FloatNotes needs your help!