Markdown
Markdown is a simple and easy to use markup language for format documents. The key concept is making the syntax for formatting as simple as possible and make the the unformatted text easy to read.
Character formatting
To emphasis words you can use the asterix and back tick characters.
Markdown:
This is **bold** text
This is *italic* text
This is `special` text
Result:
This is bold text
This is italic text
This is special text
Sections
Sections have a level defined by the number of # characters before the section name. Lower level sections are displayed in a smaller font.
Markdown:
# Heading 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
## Heading 2
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
### Heading 3
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Result:
Heading 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Heading 2
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
Heading 3
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Tables
The first line of a table contains the column names separated by | and is followed by a second line with --- separated by |. The following lines represent the cells in the body of the table.
Markdown:
Description|Quantity|Price
---|---|---
M10 bolts|5|0,50
M10 nuts|5|0,40
Steel wire|5 meter| 2,45
Result:
| Description | Quantity | Price |
|---|---|---|
| M10 bolts | 5 | 0,50 |
| M10 nuts | 5 | 0,40 |
| Steel wire | 5 meter | 2,45 |
Lists
Markdown supports ordered and unordered list. Ordered lists are defined by a digit followed by a . and unordered list start with a * or -.
Markdown
Installation procedure:
1. Unlock the screw.
1. Open the battery case.
1. Replace batteries.
Needed:
* One philips screwdriver
* 3 AA batteries
* Battery charger
Result:
Installation procedure:
- Unlock the screw.
- Open the battery case.
- Replace batteries.
Needed:
- One philips screwdriver
- 3 AA batteries
- Battery charger
Images
You can insert images using a URL or name of uploaded file.
Markdown:
