Синтаксис заголовков в Markdown
Заголовки являются важнейшими элементами для организации структуры документа. Markdown поддерживает два синтаксиса заголовков: стиль ATX и стиль Setext.
Заголовки в стиле ATX
Чтобы создать заголовок, добавьте решетку (#
) перед словом или фразой. Количество решеток определяет уровень заголовка.
# Заголовок уровня 1
## Заголовок уровня 2
### Заголовок уровня 3
#### Заголовок уровня 4
##### Заголовок уровня 5
###### Заголовок уровня 6
Визуальный вывод
Заголовок уровня 1
Заголовок уровня 2
Заголовок уровня 3
Заголовок уровня 4
Заголовок уровня 5
Заголовок уровня 6
Необязательный закрывающий синтаксис
Вы можете дополнительно "закрыть" заголовки в стиле ATX, что чисто эстетически:
# Заголовок уровня 1 #
## Заголовок уровня 2 ##
### Заголовок уровня 3 ###
Количество символов #
в конце не обязательно должно совпадать с началом; уровень заголовка определяется количеством символов в начале.
Заголовки в стиле Setext
Вы также можете добавить любое количество знаков =
под текстом для заголовка первого уровня или знаков -
для заголовка второго уровня.
Заголовок уровня 1
===============
Заголовок уровня 2
---------------
Визуальный вывод
Заголовок уровня 1
Заголовок уровня 2
Рекомендации по работе с заголовками
Соображения совместимости
Когда между решеткой (#
) и текстом заголовка нет пробела, разные приложения Markdown могут обрабатывать это по-разному. Для совместимости добавляйте пробел между решеткой и текстом заголовка.
✅ Рекомендуется | ❌ Не рекомендуется |
---|---|
# Это заголовок | #Это заголовок |
Использование пустых строк
Для совместимости добавляйте пустые строки перед заголовком и после него.
Это абзац.
# Это заголовок
Это другой абзац.
Уровни заголовков
- В каждом документе следует использовать только один заголовок первого уровня
- Сохраняйте логику уровней заголовков; не пропускайте уровни
- Заголовки должны отражать иерархическую структуру документа
Рекомендации по тексту заголовков
- Текст заголовка должен быть кратким и ясным
- Избегайте пунктуации (особенно точек)
- Используйте отглагольные существительные или именные фразы
- Сохраняйте согласованное форматирование для заголовков одного уровня
HTML-вывод
Заголовки Markdown преобразуются в соответствующие HTML-теги заголовков:
# Заголовок → <h1>Заголовок</h1>
## Заголовок → <h2>Заголовок</h2>
### Заголовок → <h3>Заголовок</h3>
#### Заголовок → <h4>Заголовок</h4>
##### Заголовок → <h5>Заголовок</h5>
###### Заголовок → <h6>Заголовок</h6>
Идентификаторы заголовков (расширенная функция)
Многие процессоры Markdown автоматически генерируют идентификаторы для заголовков, которые можно использовать для создания якорных ссылок:
<h1 id="sintaksis-zagolovkov-v-markdown">Синтаксис заголовков в Markdown</h1>
Это позволяет вам ссылаться на конкретный заголовок:
[Ссылка на заголовок](#sintaksis-zagolovkov-v-markdown)
Практический пример
Ниже приведен пример документа с хорошо структурированной иерархией заголовков:
# Руководство пользователя
## Быстрый старт
### Шаги установки
#### Системные требования
#### Загрузка и установка
### Базовая конфигурация
## Расширенные функции
### Пользовательские настройки
### Управление плагинами
## Устранение неполадок
### Часто задаваемые вопросы
### Служба поддержки
Такая четкая структура заголовков делает документ легким для чтения и навигации.