Расширение admonition модуля markdown в Python

Добавляет в документы Markdown rST стиль

Синтаксис:

import markdown

html = markdown.markdown(some_text, extensions=['admonition'])

Параметры:

some_text - разметка Markdown,
extensions - список расширений модуля.

Возвращаемое значение:

текст в формате HTML.

Описание:

Расширение markdown.extensions.admonition добавляет в документы Markdown наставления в стиле rST.

Оповещения создаются с использованием следующего синтаксиса:

!!! type "optional explicit title within double quotes"
    Any number of other indented markdown elements.

    This is the second paragraph.

type будет использоваться как имя класса CSS и заголовок по умолчанию. Это должно быть одно слово. Так, например:

!!! note
    You should note that the title will be automatically capitalized.

Отобразит:

<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You should note that the title will be automatically capitalized.</p>
</div>

При желании можно использовать собственные заголовки. Например:

!!! danger "Don't try this at home"
    ...

Отобразит:

<div class="admonition danger">
<p class="admonition-title">Don't try this at home</p>
<p>...</p>
</div>

Если не нужен заголовок, то используйте пустую строку '':

!!! important ""
    This is an admonition box without a title.

Отобразит:

<div class="admonition important">
<p>This is an admonition box without a title.</p>
</div>

Можно также указать дополнительные имена CSS-классов, разделенные пробелами. Первый класс должен быть типом. Например:

!!! danger highlight blink "Don't try this at home"
    ...

Отобразит:

<div class="admonition danger highlight blink">
<p class="admonition-title">Don't try this at home</p>
<p>...</p>
</div>

Пример добавления оповещения в разметку Markdown:

import markdown
text = """
!!! type "optional explicit title within double quotes"
    Any number of other indented markdown elements.

    This is the second paragraph.
"""
html = markdown.markdown(text, extensions=['admonition'])
print(html)
# <div class="admonition type">
# <p class="admonition-title">optional explicit title within double quotes</p>
# <p>Any number of other indented markdown elements.</p>
# <p>This is the second paragraph.</p>
# </div>