1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
# Example
This page is written in mixed markdown and reST.
Source code is [here](https://github.com/miyakogi/m2r/blob/master/docs/example.md).
## Basic Markups (inline)
A **strong**, *emphasis*, ~~deleted~~, `code with single-backtick`,
``code with two-backticks``, ```code can include multiple (``) backticks```,
:code:`reST's code role`, and <del>inline html</del>delete.
### Link
Auto link to http://example.com/.
Link to [example.com](http://example.com/) in markdown.
Link to [anchor](#testlabel) in markdown.
Link to [document](example.md) in markdown.
Link to [document with anchor](example.md#testlabel) in markdown (doc directive does not support anchors, so this links to the document only).
Link to `example.com <http://example.com/>`_ in reST.
Link to `example`_ in reST_ref.
Link to [example.com](http://example.com/ "example") with title in markdown.
.. _example: http://example.com
.. _testlabel:
## Basic Markups (block)
This is a simple sentence.
| sentence with
| newlines
| (reST)
Sentence with
hard-wrap (markdown, trailing two spaces)
> block quote
> second line
> > nested quote
---
<div style="color: red;">This is a red, raw-html block.</div>
> Block quote after raw-html directive
### List
#### Unordered list
* unordered list
new line
* next item
* nested list
with new line
* nested list item 2
* original depth
1. ordered list item
2. second
with new line
* original depth again
#### Ordered list
1. ordered list
in new line
2. second item
* nested unordered list
* second item
with new line
3. original depth
1. nested ordered list
with new line
2. again
4. original depth again
### Code Block
Simple, indented code block
pip install sphinx
Code block with triple backticks and language.
```python
def a(n: int) -> None:
for i in range(n):
print(i)
```
Triple-tildes (`~~~`) are also available.
~~~
def a(n: int) -> None:
for i in range(n):
print(i)
~~~
Here is reST style code block.
.. code-block:: python
if True:
print('\n')
## Extensions
### Table (Markdown-Style)
(cell-alignment is not supported currently)
| Table Header 1 | Table Header 2 | Table Header 3 |
|----------------|----------------|----------------|
| normal | *italic* | **bold** |
| `code` | ~~deleted~~ | <b>inline-html</b> |
### Math
This is `$E = mc^2$` inline math.
The below is math-block (markdown-style).
```math
E = mc^2
```
The below is reST-style math-block.
.. math::
E = mc^2
### Include Markdown file
To include markdown file:
```rest
.. mdinclude:: path-to-file.md
```
To include markdown file with specific lines:
```rest
.. mdinclude:: included.md
:start-line: 2
:end-line: -2
```
Original ``included.md`` file is:
.. include:: included.md
:code: md
This file included as:
```md
#### Include this line
```
and results in HTML as below:
.. mdinclude:: included.md
:start-line: 2
:end-line: -2
### Footnote
Footnote[^1] and footnote[^key] with markdown.
Footnote with reST\ [#a]_.
<!-- footnote definition -->
[^1]: footnote 1
[^key]: footnote key
.. [#a] reST footnote
|
