Markdown tutorial
Here we provide a brief tutorial to the Markdown syntax which is the basis on which Remark syntax has been built. We provide an external link to complete documentation below.
A complete syntax documentation is given in here.
Markdown syntax
Normal text
Once upon a time there was an apple-worm...
It was a very green apple-worm.
Its home was built into a red apple.
Once upon a time there was an apple-worm… It was a very green apple-worm.
Its home was built into a red apple.
Emphasis
It was a _very_ green apple-worm.
It was a __very__ green apple-worm.
It was a ___very___ green apple-worm.
It was a very green apple-worm.
It was a very green apple-worm.
It was a very green apple-worm.
Headings
Level 1
=======
Level 2
-------
### Level 3
#### Level 4
Level 1
Level 2
Level 3
Level 4
Unordered lists
Things to buy:
* apples
* royal gala for john
* red delicious for jane
* carrots
* milk
Things to buy:
- apples
- royal gala for john
- red delicious for jane
- carrots
- milk
Ordered lists
How to cook potatos:
1. Heat water to the boiling point.
5. Put water into a kettle.
3. Put the kettle on the stove.
6. Turn on the heat.
7. Wait until the water boils.
2. Put potatos into the water.
3. Decrease the heat somewhat.
* Be careful not to touch the hot stove!
* About 80% heat is fine.
3. Wait for 30 minutes.
11. Turn off the heat.
10. Pour the water out of the kettle.
How to cook potatos:
- Heat water to the boiling point.
- Put water into a kettle.
- Put the kettle on the stove.
- Turn on the heat.
- Wait until the water boils.
- Put potatos into the water.
- Decrease the heat somewhat.
- Be careful not to touch the hot stove!
- About 80% heat is fine.
- Wait for 30 minutes.
- Turn off the heat.
- Pour the water out of the kettle.
Verbatim content
Indented text.
Indented text.
In Remark, the indentation is used invoke the indentation macro, which defaults to the Verbatim macro.
Tables
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
| First Header | Second Header |
|---|---|
| Content Cell | Content Cell |
| Content Cell | Content Cell |
Definition lists
Apple
: Pomaceous fruit of plants of the genus Malus in
the family Rosaceae.
: A company.
Orange
: The fruit of an evergreen tree of the genus Citrus.
- Apple
- Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
- A company.
- Orange
- The fruit of an evergreen tree of the genus Citrus.
Punctuation
Input | Output | Html
-------------|------------|-------------------------
`'apple'` | 'apple' | `‘apple’`
`"apple"` | "apple" | `“apple”`
`apple...` | apple... | `apple…`
`pages 2--5` | pages 2--5 | `pages 2–5`
`ab --- cd` | ab --- cd | `ab — cd`
| Input | Output | Html |
|---|---|---|
'apple' |
‘apple’ | ‘apple’ |
"apple" |
“apple” | “apple” |
apple... |
apple… | apple… |
pages 2--5 |
pages 2–5 | pages 2–5 |
ab --- cd |
ab — cd | ab — cd |
Links in Markdown
[Remark syntax][]
[Indirect reference][Remark syntax]
[Indirect reference with tool-tip][IndirectTip]
[Direct reference](remark_syntax.htm)
[Direct reference with tool-tip](remark_syntax.htm "Tool-tip B")
[Remark syntax]: remark_syntax.htm
[IndirectTip]: remark_syntax.htm "Tool-tip A"
Images in Markdown
![Colors in HSV space][Image]
![Colors in HSV space][ImageTip]
[Image]: [[Ref: hsv.png]]
[ImageTip]: [[Ref: hsv.png]] "Tool-tip A"
Links in Remark
While the Markdown linking mechanism is fine (and required) for external links, you will want to use the Remark linking mechanism for links internal to the documentation. This is because it is able to automatically fetch information about the target file, helping to keep the documentation in sync.
[[Link: remark_syntax.txt]]
[[FileLink: remark_syntax.txt]]
[[DirectoryLink: remark_syntax.txt]]
When you need to give links specific names, use the following syntax:
[Remark syntax][2]
[2]: [[Ref: remark_syntax.txt]]
Remark linking relies on the file searching algorithm, which is important to make the documentation robust to changes in the directory structure.