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
|
{0 The title}
Quick reference for the odoc language rendering markdown
{1 Title}
{2 Subtitle}
{3:my_id Referenceable title}
See {!my_id}.
{3:styled Styled}
{b bold} text, {i italic} text, {e emphasized} text
H{_ 2}O and 1{^ st}
{3 Link}
Here is a link: {:https://www.example.com}.
You can also click {{:https://www.example.com}here}.
{3 References}
See an empty reference {{!test.v}}.
See {{!test.v}this function from another library}.
See {{!./test.mli}this page from another package}.
See {{!styled}this section} for the syntax of references.
{4 Subpages}
There's a subpage here {{!test}} and another one {{!test2}}
{3 Lists}
- First item
- Second item
+ First ordered item
+ Second numbered item
{ul
{- First item}
{- Second item}
{li can also be used}}
{ol
{- First numbered item}
{- Second numbered item}
{li can also be used}}
{3 Code blocks}
Inline [code].
{[
let _ = "Block code"
]}
{foo@text[
Code block with {[inner code block syntax]}
]foo}
{@python[
[i+1 for i in xrange(2)]
]}
{3 Verbatim}
{v verbatim text v}
{3 Math}
For inline math: {m \sqrt 2}.
For display math:
{math \sqrt 2}
{3 Images}
{image!odoc_logo_placeholder.jpg}
{image:https://picsum.photos/200/100}
{3 Table}
{4 Explicit syntax}
{table
{tr
{th Header 1}
{th Header 2}}
{tr
{td Cell 1}
{td Cell 2}}
{tr
{td Cell 3}
{td Cell 4}}}]}
{4 Light syntax}
{t | Header 1 | Header 2 |
|----------|----------|
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |}
{3 HTML}
This is a strong tag: {%html: <strong> Odoc language lack support for quotation! </strong>
%}
{%html:
<div>
<blockquote>
Odoc language lack support for quotation!
</blockquote>
</div>
%}
{3 Tags}
@since 4.08
Tags are explained in this section.
|
