blob: 587ae803b8121129a9f83f2ff5404515efcef636 (
plain)
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
Simple admonition
.
!!! note
*content*
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><em>content</em></p>
</div>
.
Could contain block elements too
.
!!! note
### heading
-----------
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<h3>heading</h3>
<hr>
</div>
.
Shows custom title
.
!!! note Custom title
Some text
.
<div class="admonition note">
<p class="admonition-title">Custom title</p>
<p>Some text</p>
</div>
.
Shows no title
.
!!! note ""
Some text
.
<div class="admonition note">
<p>Some text</p>
</div>
.
Closes block after 2 empty lines
.
!!! note
Some text
A code block
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Some text</p>
</div>
<pre><code>A code block
</code></pre>
.
Nested blocks
.
!!! note
!!! note
Some text
code block
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Some text</p>
<pre><code>code block
</code></pre>
</div>
</div>
.
Consecutive admonitions
.
!!! note
!!! warning
.
<div class="admonition note">
<p class="admonition-title">Note</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
</div>
.
Marker may be indented up to 3 chars
.
!!! note
content
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>content</p>
</div>
.
But that's a code block
.
!!! note
content
.
<pre><code>!!! note
content
</code></pre>
.
Some more indent checks
.
!!! note
not a code block
code block
.
<div class="admonition note">
<p class="admonition-title">Note</p>
</div>
<p>not a code block</p>
<pre><code>code block
</code></pre>
.
Type could be adjacent to marker
.
!!!note
xxx
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>xxx</p>
</div>
.
Type could be adjacent to marker and content may be shifted up to 3 chars
.
!!!note
xxx
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>xxx</p>
</div>
.
Or several spaces apart
.
!!! note
xxx
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>xxx</p>
</div>
.
Admonitions self-close at the end of the document
.
!!! note
xxx
.
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>xxx</p>
</div>
.
They could be nested in lists
.
- !!! note
- a
- b
- !!! warning
- c
- d
.
<ul>
<li>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul>
<li>a</li>
<li>b</li>
</ul>
</div>
</li>
<li>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<ul>
<li>c</li>
<li>d</li>
</ul>
</div>
</li>
</ul>
.
Or in blockquotes
.
> !!! note
> xxx
> > yyy
> zzz
>
.
<blockquote>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>xxx</p>
<blockquote>
<p>yyy
zzz</p>
</blockquote>
</div>
</blockquote>
.
Renders unknown admonition type
.
!!! unknown title
content
.
<div class="admonition unknown">
<p class="admonition-title">title</p>
<p>content</p>
</div>
.
Does not render
.
!!!
content
.
<p>!!!
content</p>
.
|
