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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
|
.. _plugins:
Built-in Plugins
================
.. meta::
:description: List of Mistune built-in plugins, their syntax and how to enable them.
Mistune offers many built-in plugins, including all the popular markups.
.. _strikethrough:
strikethrough
-------------
.. code-block:: text
~~here is the content~~
``mistune.html()`` has enabled strikethrough plugin by default. To create
a markdown instance your own::
markdown = mistune.create_markdown(plugins=['strikethrough'])
Another way to create your own Markdown instance::
from mistune.plugins.formatting import strikethrough
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[strikethrough])
footnotes
---------
.. code-block:: text
content in paragraph with footnote[^1] markup.
[^1]: footnote explain
``mistune.html()`` has enabled footnote plugin by default. To create
a markdown instance your own::
markdown = mistune.create_markdown(plugins=['footnotes'])
Another way to create your own Markdown instance::
from mistune.plugins.footnotes import footnotes
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[footnotes])
table
-----
Simple formatted table:
.. code-block:: text
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
Complex formatted table:
.. code-block:: text
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
Align formatted table:
.. code-block:: text
Left Header | Center Header | Right Header
:----------- | :-------------: | ------------:
Conent Cell | Content Cell | Content Cell
| Left Header | Center Header | Right Header |
| :---------- | :-------------: | ------------: |
| Conent Cell | Content Cell | Content Cell |
``mistune.html()`` has enabled table plugin by default. To create
a markdown instance your own::
markdown = mistune.create_markdown(plugins=['table'])
Another way to create your own Markdown instance::
from mistune.plugins.table import table
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[table])
url
---
URL plugin enables creating link with raw URL by default:
.. code-block:: text
For instance, https://typlog.com/
Will be converted into:
.. code-block:: html
<p>For instance, <a href="https://typlog.com/>https://typlog.com/</a></p>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. Mistune
values explicit, and we suggest writers to write links in:
.. code-block:: text
<https://typlog.com/>
To enable **url** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['url'])
Another way to create your own Markdown instance::
from mistune.plugins.url import url
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[url])
task_lists
----------
Task lists plugin enables creating GitHub todo items:
.. code-block:: text
- [x] item 1
- [ ] item 2
Will be converted into:
.. code-block:: html
<ul>
<li class="task-list-item"><input class="task-list-item-checkbox" type="checkbox" disabled checked/>item 1</li>
<li class="task-list-item"><input class="task-list-item-checkbox" type="checkbox" disabled/>item 2</li>
</ul>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**task_lists** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['task_lists'])
Another way to create your own Markdown instance::
from mistune.plugins.task_lists import task_lists
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[task_lists])
def_list
--------
def_list plugin enables creating html definition lists:
.. code-block:: text
First term
: First definition
: Second definition
Second term
: Third definition
Will be converted into:
.. code-block:: html
<dl>
<dt>First term</dt>
<dd>First definition</dd>
<dd>Second definition</dd>
<dt>Second term</dt>
<dd>Third definition</dd>
</dl>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**def_list** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['def_list'])
Another way to create your own Markdown instance::
from mistune.plugins.def_list import def_list
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[def_list])
abbr
----
abbr plugin enables creating abbreviations:
.. code-block:: text
The HTML specification
is maintained by the W3C.
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
Will be converted into:
.. code-block:: html
The <abbr title="Hyper Text Markup Language">HTML</abbr> specification
is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**abbr** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['abbr'])
Another way to create your own Markdown instance::
from mistune.plugins.abbr import abbr
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[abbr])
mark
----
mark plugin adds the ability to insert ``<mark>`` tags. To mark some text, simply surround the text with ``==``:
.. code-block:: text
==mark me== ==mark with\=\=equal==
Will be converted into:
.. code-block:: html
<mark>mark me</mark> <mark>mark with==equal</mark>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**mark** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['mark'])
Another way to create your own Markdown instance::
from mistune.plugins.formatting import mark
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[mark])
insert
------
insert plugin adds the ability to insert ``<ins>`` tags. To insert some text, simply surround the text with ``^^``:
.. code-block:: text
^^insert me^^ ^^insert\^\^me^^
Will be converted into:
.. code-block:: html
<ins>insert me</ins> <ins>insert^^me</ins>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**insert** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['insert'])
Another way to create your own Markdown instance::
from mistune.plugins.formatting import insert
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[insert])
superscript
-----------
superscript plugin adds the ability to insert ``<sup>`` tags. The syntax looks like:
.. code-block:: text
Hello^superscript^
Will be converted into:
.. code-block:: html
<p>Hello<sup>superscript</sup></p>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**superscript** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['superscript'])
Another way to create your own Markdown instance::
from mistune.plugins.formatting import superscript
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[superscript])
subscript
---------
subscript plugin adds the ability to insert ``<sub>`` tags. The syntax looks like:
.. code-block:: text
Hello~subscript~
CH~3~CH~2~OH
Will be converted into:
.. code-block:: html
<p>Hello<sub>subscript</sub></p>
<p>CH<sub>3</sub>CH<sub>2</sub>OH</p>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**subscript** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['subscript'])
Another way to create your own Markdown instance::
from mistune.plugins.formatting import subscript
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[subscript])
math
----
Math plugin wraps ``<div>`` for block level math syntax, and ``<span>`` for inline level
math syntax.
A block math is surrounded with ``$$``:
.. code-block:: text
$$
\operatorname{ker} f=\{g\in G:f(g)=e_{H}\}{\mbox{.}}
$$
Will be converted into:
.. code-block:: html
<div class="math">$$
\operatorname{ker} f=\{g\in G:f(g)=e_{H}\}{\mbox{.}}
$$</div>
An inline math is surrounded with ``$`` inline:
.. code-block:: text
function $f$
Will be converted into:
.. code-block:: html
<p>function <span class="math">$f$</span></p>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**math** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['math'])
Another way to create your own Markdown instance::
from mistune.plugins.math import math
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[math])
ruby
----
insert plugin adds the ability to insert ``<ruby>`` tags. Here are some examples for ruby syntax:
.. code-block:: text
[漢字(ㄏㄢˋㄗˋ)]
[link]: /url
[漢字(ㄏㄢˋㄗˋ)][link]
[漢字(ㄏㄢˋㄗˋ)](/url)
[漢(ㄏㄢˋ)字(ㄗˋ)]
Will be converted into:
.. code-block:: html
<p><ruby><rb>漢字</rb><rt>ㄏㄢˋㄗˋ</rt></ruby></p>
<p><a href="/url"><ruby><rb>漢字</rb><rt>ㄏㄢˋㄗˋ</rt></ruby></a></p>
<p><a href="/url"><ruby><rb>漢字</rb><rt>ㄏㄢˋㄗˋ</rt></ruby></a></p>
<p><ruby><rb>漢</rb><rt>ㄏㄢˋ</rt></ruby><ruby><rb>字</rb><rt>ㄗˋ</rt></ruby></p>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**ruby** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['ruby'])
Another way to create your own Markdown instance::
from mistune.plugins.ruby import ruby
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[ruby])
Blog post: https://lepture.com/en/2022/markdown-ruby-markup
spoiler
-------
Spoiler plugin wraps ``<div class="spoiler">`` for block level syntax,
and ``<span class="spoiler">`` for inline level syntax.
A block level spoiler looks like block quote, but the marker is ``>!``:
.. code-block:: text
>! here is the spoiler content
>!
>! it will be hidden
Will be converted into:
.. code-block:: html
<div class="spoiler">
<p>here is the spoiler content</p>
<p>it will be hidden</p>
</div>
An inline spoiler is surrounded with ``>!`` and ``!<``:
.. code-block:: text
this is the >! hidden text !<
Will be converted into:
.. code-block:: html
<p>this is the <span class="spoiler">hidden text</span></p>
This plugin is **NOT ENABLED** by default in ``mistune.html()``. To enable
**spoiler** plugin with your own markdown instance::
markdown = mistune.create_markdown(plugins=['spoiler'])
Another way to create your own Markdown instance::
from mistune.plugins.spoiler import spoiler
renderer = mistune.HTMLRenderer()
markdown = mistune.Markdown(renderer, plugins=[spoiler])
|
