Markdown is a text formatting syntax inspired on plain text email. In the words of its creator, John Gruber:
The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.
Strong and Emphasize
strong and emphasize
**strong**
_emphasize_
Strikethrough
delete this text
~~delete this text~~
Links
[link text](https://url.com/ "title")
[link text](https://url.com/)
<https://url.com>
Learn more about links in Typlog.
Images


Image with "title"
will be shown as <figcaption>
.
Image Gallery is formatted by multiple image markup:
 

Learn more about images in Typlog.
Headers
Atx-style headers:
# h1
## h2
### h3
…
Closing # are optional.
# h1 #
## h2 ##
…
Lists
There are two types of list.
Ordered List
Ordered list without paragraphs:
- foo
- bar
1. foo
2. bar
Unordered List
Unordered list with paragraphs:
A list item.
With multiple paragraphs.
bar
* A list item.
With multiple paragraphs.
* bar
You can nest them:
* Abacus
* anser
* Bubbles
1. bunk
2. bupkis
* bar
3. burper
* Cunning
Blockquotes
Email-style angle brackets are used for blockquotes.
> Email-style angle brackets
> are used for blockquotes.
> > And, they can be nested.
> #### Headers in blockquotes
>
> * You can quote a list.
> * Etc.
Horizontal Rules
Three or more dashes for asterisks.
---
***
Manual Line Breaks
End a line with two or more spaces:
Roses are red,
Violets are blue.
Roses are red, [space][space]
Violets are blue. [space][space]
Fenced Code
Besides indenting with 4 spaces for a code block, there is fenced code block.
```python
def hello():
print('hello')
```
Footnotes
Here is a footnote1. The key is better to be word-word
style.
Here is a footnote[^key]. The key is better to be `word-word` style.
[^key]: Some explain for this footnote.
TOC
Table of contents can be put by:
.. toc::
Or with a title:
.. toc:: TOC title
Math
Math is supported via MathJax. A simple example by MathJax:
Inline level math $ax^2 + bx + c = 0$ is wrapped with `$
and $`
:
`$ax^2 + bx + c = 0$`
Block level math is wrapped with language math fenced code:
```math
ax^2 + bx + c = 0
```
Some explain for this footnote.↩