Markdown: полная шпаргалка по синтаксису

Markdown — облегчённый язык разметки, созданный Джоном Грубером в 2004 году. Он широко используется в README, документации, блогах и системах контроля версий. В этой статье — полная шпаргалка по синтаксису с примерами.

Для проверки разметки в реальном времени удобен Markdown Preview на rechecker.ru.

Заголовки

Заголовки создаются символом #. Уровень определяется количеством решёток:

# Заголовок H1
## Заголовок H2
### Заголовок H3
#### Заголовок H4
##### Заголовок H5
###### Заголовок H6

Альтернативный синтаксис для H1 и H2 (только в некоторых парсерах):

Заголовок H1
===========

Заголовок H2
-----------

Форматирование текста

Списки

Нумерованные списки

1. Первый пункт
2. Второй пункт
3. Третий пункт

Маркированные списки

- Пункт с дефисом
* Пункт со звёздочкой
+ Пункт с плюсом

Вложенные списки

- Уровень 1
  - Уровень 2
    - Уровень 3

Чек-листы (GitHub Flavored Markdown)

- [x] Выполнено
- [ ] Не выполнено

Ссылки и изображения

Ссылки

[Текст ссылки](https://example.com)
[Ссылка с подсказкой](https://example.com "Подсказка при наведении")
[Ссылка-ссылка][1]

[1]: https://example.com

Изображения

![Альтернативный текст](https://example.com/image.png)
![С подсказкой](image.png "Подсказка")

Код

Инлайн-код

Используйте функцию `printf()` для вывода.

Блоки кода

Три обратных кавычки с указанием языка:

```javascript
function hello() {
  console.log("Hello, World!");
}
```

```python
def greet(name):
    return f"Hello, {name}!"
```

Поддерживаемые языки: javascript, python, php, bash, sql, json, html, css и другие.

Таблицы

| Колонка 1 | Колонка 2 | Колонка 3 |
|-----------|-----------|-----------|
| Ячейка 1  | Ячейка 2  | Ячейка 3  |
| Ячейка 4  | Ячейка 5  | Ячейка 6  |

Выравнивание (некоторые парсеры):

| По левому | По центру | По правому |
|:----------|:---------:|----------:|
| Текст     | Текст     | Текст     |

Цитаты

> Цитата первого уровня
>> Вложенная цитата
>>> Глубокая вложенность

Горизонтальная линия

---
***
___

Три или более символов -, * или _ на отдельной строке.

Экранирование

Специальные символы экранируются обратным слешем:

\* не курсив
\[ не ссылка
\# не заголовок

Расширенный синтаксис (GFM, CommonMark)

Автоматические ссылки

<https://example.com>
<user@example.com>

Определения

Термин
: Определение термина

Зачёркивание

~~удалённый текст~~

Задачи

- [x] Задача выполнена
- [ ] Задача не выполнена

Диаграммы (Mermaid, не везде)

```mermaid
graph TD
    A[Старт] --> B{Условие}
    B -->|Да| C[Результат 1]
    B -->|Нет| D[Результат 2]
```

Рекомендации по использованию

1. Пустая строка перед заголовками — улучшает совместимость между парсерами
2. Пробелы после маркеров списков — обязательны для корректного отображения
3. Пустая строка перед блоками кода — предотвращает слияние с текстом
4. Язык в блоках кода — включает подсветку синтаксиса

Инструмент Markdown на rechecker.ru позволяет проверять разметку в реальном времени и экспортировать результат. Используйте его при написании README, документации и технических статей.