Markdown is a syntax to format the display of content stored as plain text - similar but simpler than HTML formatting
- System-independent
- Text only format (perfect for version control)
- Separation of content vs. presentation
- Human-readable (i.e. more than HTML)
- Can also contain HTML snippets
Headings from h1 through h6 are constructed with a # for each level:
This is bold text
This is also bold text
This is italic text
This is also italic text
Strikethrough
This is an example Blockquote.
Unordered
- Create a list by starting a line with
-, or* - Sub-lists are made by indenting 2 spaces:
- So this is a sub-list item!
Ordered
-
Lorem ipsum dolor sit amet
-
Consectetur adipiscing elit
-
Integer molestie lorem at massa
-
You can use sequential numbers...
-
...or keep all the numbers as
1.
Start numbering with offset:
- foo
- bar
To create code blocks you can indent every line of the block by at least four spaces or one tab
<html>
<head>
</head>
</html>
You can also create code blocks without indenting lines, using inline backticks or triple backticks fenced code blocks.
Inline code
Block code "fences"
Sample text here...
Syntax highlighting
var foo = function (bar) {
return bar++;
};
console.log(foo(5));| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Right aligned columns
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Autoconverted link https://github.com/nodeca/pica
