Заголовки являются основой любого Markdown документа. Они определяют структуру, обеспечивают навигацию, влияют на доступность и влияют на SEO. Это руководство охватывает все, что касается Markdown рубрики синтаксис, правила иерархии, различия в платформах и передовые практики.
Синтаксис заголовка
Markdown заголовки используют # символ (стиль ATX). Количество # символы определяет уровень заголовка:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Существует также стиль Setext (только H1 и H2):
Heading 1
=========
Heading 2
---------
В стиле ATX (#) предпочтительнее она более ясная и работает на всех шести уровнях.
Что означает каждый уровень
| Уровень | HTML Значок | Цель |
|---|---|---|
| H1 | <h1> | Заголовок страницы или документа |
| H2 | <h2> | Основная секция |
| H3 | <h3> | Подраздел в H2 |
| H4 | <h4> | Подподпункт в H3 |
| H5 | <h5> | Редко используется на практике |
| H6 | <h6> | Почти никогда не нужен |
В большинстве документов используется только H1H3. H4H6 обычно указывает на слишком глубокую структуру документа.
H1: один на страницу
Заголовок H1 должен появляться ровно один раз в Markdown документе. Он представляет заголовок документа или основную тему страницы.
Хорошо .
# How to Convert Word to Markdown
Избегайте:
# Section One
...
# Section Two ← Don't use multiple H1s
Поисковые системы и инструменты доступности ожидают одного H1 на странице. Множество H1 сбивает с толку оба.
Правила иерархии заголовков
Всегда двигайся в последовательности. Не пропустите уровни:
Правильно:
# Document Title
## Section
### Subsection
#### Detail
Неправильно:
# Document Title
#### Jumped to H4 ← Skips H2 and H3
Пропускание уровней заголовка нарушает обзор документа и не соответствует руководящим принципам доступности WCAG.
Преобразование Word заголовков в Markdown
Когда вы конвертируете Word документ с помощью WordToMD, Words встроенные стили заголовка прямо:
| Word Стиль | Markdown Выпуск |
|---|---|
| Рубрика 1 | # Heading |
| Рубрика 2 | ## Heading |
| Рубрика 3 | ### Heading |
| Нормальный + черный | **Bold text** (НЕТ заголовка) |
Наиболее распространенная проблема: писатели вручную увеличивают размер шрифта вместо того, чтобы применять стиль заголовка. Это создает текст, который выглядит как заголовок в Word, но конвертирует в простой жирный текст в Markdown. См. также: Word к Markdown Руководство по форматированию как это исправить.
Идентификаторы заголовков и якорные ссылки
Большинство Markdown процессоров автоматически генерируют идентификаторы из текста заголовка:
## Getting Started
Генераторы: <h2 id="getting-started">Getting Started</h2>
Вы можете ссылаться на него:
See the [Getting Started section](#getting-started).
Правила для автоматически генерируемых идентификаторов:
- Все символы на малых буквах
- Заменить пробелы с запятой
- Специальные символы, за исключением запятых
Примеры:
## API Reference→#api-reference## What's New?→#whats-new## Step 1: Install→#step-1-install
Содержание
Для длинных документов создать TOC с помощью заголовков с анкерными ссылками:
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Basic Settings](#basic-settings)
- [Advanced Options](#advanced-options)
- [Usage](#usage)
- [FAQ](#faq)
GitHub автоматически генерирует TOC в верхнем левом углу любого файла Markdown с заголовками.
SEO Рассмотрения
Для Markdown, используемого на статических сайтах (Jekyll, Hugo, Astro) и опубликованного в сети:
- H1 = заголовок страницы Включите основное ключевое слово. Один на страницу.
- H2s = основные секции Включите вторичные ключевые слова естественным образом
- H3s = подразделы Более конкретные темы
- Держите заголовки описательными Как устанавливать зависимости биты Установка
- Заголовки индексируются поисковыми системами делают их сканируемыми
См. также: Word на генератор статического сайта для публикации Markdown документов в сети.
Доступность
Читатели экранов используют иерархию заголовков, чтобы помочь пользователям ориентироваться. Руководящие принципы:
- Не пропустите уровни курса (H1 → H3 без H2)
- Не используйте заголовки только для визуального форматирования (вместо этого используйте жирные или CSS)
- Сделайте текст заголовка содержательным избегайте Раздела 1, Часть А
- Держите заголовки краткими, но описательными
Редактирование заголовка по платформам
| Платформа | H1-H6 | Автоматические идентификаторы | Автоматический контроль |
|---|---|---|---|
| GitHub | ✅ | ✅ | ✅ (через кнопку) |
| Obsidian | ✅ | ✅ | Через плагин |
| GitBook | ✅ | ✅ | ✅ (бочная панель) |
| Notion | Только H1-H3 | ❌ | ❌ |
| VS Код предварительного просмотра | ✅ | ✅ | ❌ |
| Я не знаю. | ✅ | ✅ | ✅ |
Notion поддерживает только три уровня заголовков (называемые заголовками 1, 2 и 3 в их редакторе, соотношение с H1H3).
Частые ошибки
Забудьте о пространстве после #
#Not a heading ← Missing space
# This is correct
Пространство между # и текст заголовка требуется в CommonMark.
Использование заголовков для оформления, а не для структуры
Использование ### Сделать текст немного меньше, не являясь фактическим подразделом, нарушает структуру документа. Вместо этого используйте стилизованный текст или классы CSS.
Слишком большое гнездование Если вам нужны H5 и H6, подумайте, следует ли разделить содержимое на отдельные страницы.
FAQ
В чем разница между стилями заголовков ATX и Setext?
Использование ATX # персонажей. Подчеркивает использование шести текстов (=== для H1, --- для H2). ATX предпочтительнее, потому что он недвусмыслен и работает для H1H6.
Могу я получить несколько H2s? Да, в этом вся суть. H2 определяет основные разделы, и документ обычно имеет несколько.
Пропускание курса влияет на SEO? Это влияет на доступность больше, чем SEO непосредственно, но чистая семантическая структура является положительным сигналом. Поисковые системы предпочитают хорошо структурированный контент.
В моем преобразованном документе все заголовки находятся на одном уровне. Что пошло не так? Документ Word использовал ручное форматирование вместо стилей заголовка. См. также: Word к Markdown Руководство по форматированию за лекарство.
Заключение
Markdown заголовки просты по синтаксису, но важны по своему влиянию. Используйте H1 один раз в качестве заголовка документа, H2 для основных разделов и H3 для подразделов. Держите иерархию чистой, не пропустите уровни и напишите описательный текст заголовка. При преобразовании Word документов с помощью WordToMD, убедитесь, что источник использует встроенные стили заголовка Word для чистого преобразования.