Markdown: синтаксис и примеры
Заголовки, выделение, списки, ссылки, код, таблицы и чек-листы с примерами результата.
Синтаксис Markdown и результат
Нажмите на любой пример синтаксиса, чтобы скопировать его. Метка GFM отмечает расширения в стиле GitHub.
| Синтаксис | Результат | Когда использовать | ||||
|---|---|---|---|---|---|---|
| Структура документаЗаголовки, абзацы, переносы и смысловые блоки. | ||||||
Раздел | Заголовок От одного до шести знаков # задают уровень заголовка. CommonMark | |||||
Первый абзац. Второй абзац. | Новый абзац Пустая строка разделяет два абзаца. CommonMark | |||||
Первая строка Вторая строка | Перенос строки Два пробела в конце строки создают перенос без нового абзаца. CommonMark Важны пробелы | |||||
| Горизонтальный разделитель Отделяет одну смысловую часть документа от другой. CommonMark | ||||||
Важная мысль | Цитата Знак > в начале строки оформляет цитату или примечание. CommonMark | |||||
| Выделение в строкеАкценты, код и экранирование специальных знаков. | ||||||
важный текст | Полужирный текст Двойные звёздочки создают сильное выделение. CommonMark | |||||
акцент | Курсив Одна звёздочка с каждой стороны создаёт обычный акцент. CommonMark | |||||
сильный акцент | Полужирный курсив Три звёздочки объединяют два вида выделения. CommonMark | |||||
| Зачёркивание Показывает удалённый или больше не актуальный фрагмент. GFM | ||||||
npm run build | Код в строке Обратные кавычки выделяют команду, имя файла или короткий код. CommonMark | |||||
*не курсив* | Экранирование Обратная косая черта выводит служебный знак как обычный текст. CommonMark | |||||
| СпискиМаркированные, нумерованные, вложенные списки и задачи. | ||||||
| Маркированный список Дефис и пробел в начале каждой строки создают пункты. CommonMark | |||||
| Нумерованный список Число, точка и пробел создают последовательность шагов. CommonMark | |||||
| Вложенный список Отступ перед маркером помещает пункт на следующий уровень. CommonMark | |||||
| Список задач Квадратные скобки добавляют отмеченные и неотмеченные задачи. GFM | |||||
| Ссылки и изображенияАдреса, подписи, изображения и переиспользуемые определения. | ||||||
| Ссылка Текст ссылки помещается в квадратные скобки, адрес — в круглые. CommonMark | ||||||
| Автоматическая ссылка Угловые скобки превращают полный URL в ссылку без отдельной подписи. CommonMark | ||||||
IMG · Описание | Изображение Восклицательный знак перед синтаксисом ссылки вставляет изображение. CommonMark | |||||
| Ссылка по идентификатору Определение внизу документа позволяет повторно использовать один адрес. CommonMark | ||||||
| Код и данныеМногострочный код, таблицы и скрытые комментарии. | ||||||
| Блок кода Три обратные кавычки сохраняют форматирование; язык включает подсветку, если она поддерживается. CommonMark | |||||
| Таблица Вертикальные черты задают столбцы, а строка с дефисами отделяет заголовок. GFM | |||||
Не отображается на странице | Скрытый комментарий HTML-комментарий остаётся в исходнике, но не виден в готовом документе. CommonMark Важны пробелы | |||||
Пишите переносимый Markdown
- Разделяйте блоки
- Оставляйте пустую строку между абзацами, списками и блоками кода.
- Экранируйте маркеры
- Поставьте обратную косую черту перед *, # или другим знаком, если он должен остаться текстом.
- Проверяйте редактор
- Таблицы, чек-листы и зачёркивание относятся к GFM и работают не везде.
- Сохраняйте читаемость
- Давайте ссылкам понятные подписи, а после ограды кода указывайте язык.
Синтаксис сверен со спецификациями CommonMark 0.31.2 и GitHub Flavored Markdown.
Конвертировать Markdown в HTMLПродолжите работу с текстом
Скопируйте символ, преобразуйте разметку, очистите фрагмент или сохраните результат в блокноте.
- Кодировать и декодировать HTML-сущности Преобразуйте спецсимволы в безопасные HTML-сущности и обратно.
- Конвертировать Markdown в HTML Подготовьте HTML-разметку из Markdown-черновика.
- Удалить HTML-теги Оставьте читаемый текст без разметки.
- Изменить регистр текста Переведите буквы в верхний или нижний регистр.
- Открыть онлайн-блокнот Используйте скопированные символы в локальной заметке.
Вопросы о Markdown
Чем Markdown отличается от GFM?
CommonMark описывает основной синтаксис Markdown. GitHub Flavored Markdown дополняет его таблицами, чек-листами, зачёркиванием и расширенным распознаванием ссылок.
Почему один Markdown отображается по-разному?
Сайты и редакторы могут использовать разные парсеры и наборы расширений. Базовый синтаксис переносим лучше, а поддержку расширений стоит проверять на целевой платформе.
Как сделать обычный перенос строки?
Поставьте два пробела в конце строки. Пустая строка создаёт уже новый абзац.
Можно ли скопировать пример целиком?
Да. Каждая ячейка с синтаксисом работает как кнопка и копирует точный Markdown-код вместе с переносами и пробелами.