Краткий обзор раздела: Модуль python-markdown в Python

Модуль markdown предназначен для преобразования синтаксиса Markdown в HTML. Проект Python-Markdown предоставляет две общедоступные функции markdown.markdown() и markdown.markdownFromFile(), которые обертывают класс markdown.Markdown().

Расширение markdown.extensions.abbr добавляет возможность определять сокращения. В частности, любое определенное сокращение заключено в HTML тег <abbr>.

Расширение markdown.extensions.attr_list добавляет синтаксис для определения атрибутов различных элементов HTML в выводе markdown.

Расширение markdown.extensions.def_list добавляет возможность создавать в документах Markdown списки определений - HTML-элементы: <dl>, <dt>, <dd>.

Расширение markdown.extensions.fenced_code добавляет дополнительный способ определения изолированного блоков кода, которые определяются с использованием синтаксиса, популяризированного в GitHub Flavored Markdown.

Расширение markdown.extensions.footnotes добавляет синтаксис для определения сносок в документах Markdown. Синтаксис сносок этого расширения модуля markdown следует общепринятому синтаксису сообщества Markdown в целом.

Расширение markdown.extensions.md_in_html анализирует Markdown внутри HTML-тегов. Атрибуту HTML-тега markdown можно присвоить одно из трех значений: "1", "block", или "span".

Расширение markdown.extensions.tables добавляет возможность создавать таблицы в документах Markdown.

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

Расширение markdown.extensions.codehilite добавляет подсветку кода/синтаксиса к стандартным блокам кода разметки Markdown с использованием модуля pygments. Для использования расширения необходимо загрузить и установить модуль pygments.

Большинство пользователей никогда не использовали этот синтаксис, и он устарел в пользу расширения attr_list. Данное расширение legacy_attrs восстанавливает прежнее поведение для документов Markdown, использующие старый синтаксис.

Устаревшее расширение markdown.extensions.legacy_em восстанавливает исходное поведение Markdown для выделения акцента при использовании синтаксиса подчеркиваний.

Устаревшее расширение markdown.extensions.meta добавляет синтаксис для определения метаданных документа Markdown. Разметка мета-данных документа Markdown состоит из серии ключевых слов и значений, определенных в начале документа.

Расширение markdown.extensions.nl2br (New-Line-to-Break) приведет к тому, что новые строки будут обрабатываться как жесткие разрывы. Как это делают StackOverflow и GitHub Markdown.

Расширение markdown.extensions.sane_lists изменяет поведение синтаксиса определения списков в документах Markdown, делая его более предсказуемым.

Расширение markdown.extensions.toc автоматически генерирует оглавление из разметки Markdown и добавляет его в итоговый HTML-документ.

Расширение markdown.extensions.wikilinks добавляет поддержку WikiLinks. В частности, любое слово [[в квадратных скобках]] преобразуется в ссылку.

Модуль misaka - это привязка на основе CFFI для библиотеки Hoedown, написанной на языке C. В ней есть быстрое средство визуализации HTML и функциональность для создания настраиваемых средств визуализации (например, страниц руководства или LaTeX).

В разделе рассмотрен синтаксис классической реализации Markdown от Джона Грубера [John Gruber].