Парсер Markdown

GFM (GitHub Flavored Markdown) — это диалект Markdown, используемый GitHub. Он расширяет стандартный Markdown возможностями, такими как таблицы, списки задач, зачёркнутый текст и автоматические ссылки.

Парсер отображает ограждённые блоки кода. Для полной подсветки синтаксиса с цветами вы можете дополнить его таблицей стилей CSS, оформляющей элементы кода.

Да! Напишите свой Markdown в редакторе, скопируйте отрендеренный HTML и используйте его в вашей документации, блоге или веб-сайте.

Первоначальный Markdown (2004) оставлял многие пограничные случаи неопределёнными, из-за чего реализации разошлись. CommonMark — это строгая спецификация, разрешающая эти неоднозначности; GFM (GitHub Flavored Markdown) — это CommonMark плюс расширения: таблицы, списки задач, зачёркивание, автоссылки и фильтр disallowed-raw-HTML. Этот инструмент рендерит GFM, что соответствует тому, что вы видите на GitHub.

Заключайте инлайн-код в одинарные обратные кавычки. Отгороженные (fenced) блоки используют тройные обратные кавычки с тегом языка для подсветки синтаксиса — например, ```python в первой строке — либо отступ в четыре пробела для каждой строки (старый синтаксис, который плохо взаимодействует внутри списков). Тройные тильды тоже работают как ограждение, если ваш код сам содержит обратные кавычки.

Да — инлайн-теги HTML передаются на выход без изменений. Расширение disallowed-raw-HTML в GFM вырезает лишь несколько опасных тегов (script, style, iframe и им подобные), когда фильтр включён. Два нюанса: блочный HTML обёртывает содержимое, внутри которого обработка синтаксиса Markdown прекращается (пустые строки имеют значение), а любой Markdown, отправляемый пользователями, нужно защищать от XSS не только фильтром тегов.

Строки, разделённые вертикальными чертами, с разделительной строкой из дефисов под заголовком. Двоеточия задают выравнивание: двоеточие-дефис слева — по левому краю (по умолчанию), двоеточия с обоих концов — по центру, дефис-двоеточие — по правому. Ячейки не могут содержать блочные элементы; экранируйте литеральную вертикальную черту как \|; внешние вертикальные черты в каждой строке необязательны. Более сложные макеты требуют raw HTML или движка документации.

Обычные подозреваемые: непоследовательные отступы (вложенные элементы обычно должны быть выровнены по первому символу содержимого родительского элемента), отсутствие пустой строки между абзацем и списком или табуляция, смешанная с пробелами. CommonMark задаёт точные правила для всех этих случаев. Преобразование табуляции в пробелы и добавление пустых строк вокруг списков устраняет подавляющее большинство ошибок вложенности.