Шпаргалка по Markdown
Выберите тему Markdown
Начните с одной группы примеров, а затем откройте полный справочник.
Основной синтаксис Markdown сгруппирован по категориям и показан как готовый для копирования исходный текст вместе с результатом настоящего парсера. Справочник охватывает основы CommonMark (заголовки, списки, выделение, ссылки, изображения и огороженные блоки кода) и расширения GitHub Flavored Markdown (таблицы, списки задач, зачёркивание и автоматические ссылки для обычных URL). Держите его под рукой при работе с GitHub, GitLab, Obsidian и генераторами статических сайтов.
Как пользоваться шпаргалкой
-
1
Просматривайте по категориям
Переходите к заголовкам, спискам, коду, ссылкам, таблицам или расширениям GFM.
-
2
Сравнивайте исходник и результат
Каждый пример показывает исходный Markdown рядом с результатом настоящего парсера GFM.
-
3
Копируйте фрагмент
Нажмите «Копировать», чтобы получить исходный код любого примера.
-
4
Проверьте метку синтаксиса
Каждый пример отмечен как CommonMark или GitHub Flavored Markdown (GFM).
Заголовки
# Заголовок H1
## Раздел H2
### Подраздел H3
Используйте стиль ATX (#), а не Setext (=== под текстом). Все парсеры поддерживают оба варианта, но ATX легче читается в diff.
Выделение
*курсив* или _курсив_, **жирный** или __жирный__, ***жирный курсив***. GFM добавляет ~~зачёркивание~~.
Списки
Неупорядоченные списки используют -, * или + (выберите один вариант и придерживайтесь его):
- Первый
- Второй
- Вложенный (два пробела)
Упорядоченные списки нумеруются автоматически:
1. Элемент
1. Элемент
1. Элемент
Код
Встроенный: `code`. Огороженные блоки с необязательным языковым тегом:
```python
def hello(name):
return f"Привет, {name}"
```
Если вам ближе старый синтаксис, сделайте для блока кода отступ в четыре пробела.
Ссылки и изображения
[Текст ссылки](https://example.com)
[Ссылка с заголовком](https://example.com "Подсказка")

Ссылочный стиль позволяет вынести длинные URL за пределы абзаца:
См. [документацию][1].
[1]: https://example.com/docs
Таблицы (GFM)
| Col A | Col B |
|-------|------:|
| a | 1 |
| b | 22 |
Выравнивание задаётся двоеточиями в строке-разделителе: :---, по левому краю, :---:, по центру, ---:, по правому краю.
Списки задач (GFM)
- [x] Готово
- [ ] Сделать
Частые ошибки
- Два пробела в конце строки вставляют перенос строки внутри абзаца. Один пробел лишь соединяет строки.
- Перед большинством блочных элементов (заголовками, списками, блоками кода) нужна пустая строка.
- Не делайте отступ у маркеров списка табуляцией, если ваш рендерер ожидает пробелы; используйте два или четыре пробела.
- Экранируйте обратной косой чертой, чтобы показать знак препинания буквально:
\*не курсив\*. - Умные кавычки различаются в зависимости от рендерера. GitHub оставляет их как есть, а Pandoc преобразует.
Часто задаваемые вопросы
CommonMark определяет переносимое ядро, включая заголовки, списки, ссылки и огороженные блоки кода с необязательной информационной строкой. GFM добавляет таблицы, списки задач, зачёркивание и автоматические ссылки для обычных URL. Другие редакторы могут поддерживать только часть синтаксиса или добавлять собственные расширения.
Markdown воспринимает одиночный перенос строки как пробел. Чтобы получить <br>, завершите строку двумя пробелами или используйте \ в конце строки в GFM.
Да, в большинстве парсеров блочные HTML-теги передаются без изменений. Некоторые рендереры очищают их (например, GitHub удаляет встроенные скрипты и атрибуты событий).
В CommonMark нет встроенного синтаксиса оглавления. GitHub создаёт якоря заголовков и показывает структуру файлов с несколькими заголовками. На других платформах действуют свои правила: MkDocs может использовать [TOC] при включённом расширении, а Docusaurus строит оглавление страницы по заголовкам.
Правила CommonMark и GFM работают. При этом Obsidian добавляет вики-ссылки ([[Имя страницы]]), выноски (callout) и встроенные блоки, которые есть только в Obsidian, их в этой шпаргалке нет.
Сопутствующие инструменты
Справочная таблица ASCII
Полная таблица ASCII от 0 до 127 с десятичным, шестнадцатеричным, восьмеричным и двоичным представлением, а также записью числовых ссылок HTML, включая NUL, LF и DEL.
Справочник сочетаний клавиш
Ищите документированные сочетания по умолчанию для VS Code, Chrome и Bash с GNU Readline в macOS, Windows и Linux.
Справочник символов HTML
Справочник HTML-сущностей с поиском, их именованными и числовыми кодами, а также копированием специальных символов и знаков одним кликом.
Счетчик FPS
Измерьте FPS браузера через requestAnimationFrame: сглаживание, минимальная и максимальная частота кадров, порог предупреждения и график по желанию. Работает локально, без загрузок и API.
Генератор цветовой палитры
Создавайте монохромные, аналоговые, комплементарные, триадные или тетрадные палитры из базового HEX-цвета и экспортируйте готовые CSS-переменные.
Генератор случайных букв
Генерируйте случайные буквы A-Z. Выберите количество, верхний или нижний регистр либо смешанный вариант для игр, заданий и уроков.