Какво е йерархия на заглавията в Markdown?

Заглавията в Markdown се дефинират с помощта на символа # — един # за H1, два за H2, до шест за H6. Те образуват структурния гръбнак на документа, подобно на съдържание. Добре структуриран документ използва заглавия в логичен, вложен ред: H1 като заглавие на най-високо ниво, H2 за основни раздели, H3 за подраздели и така нататък.

Когато заглавията се използват в неправилен ред — например, преминаване директно от H2 към H4 — това нарушава семантичния контур и може да навреди на достъпността (екранните четци разчитат на реда на заглавията) и SEO (търсачките използват заглавия, за да разберат йерархията на съдържанието). Визуализирането на йерархията улеснява откриването на тези проблеми преди публикуване.

Описание на инструмента

Този инструмент анализира текст на Markdown и показва всички заглавия, базирани на #, като интерактивно, сгъваемо дърво. Можете да видите с един поглед как е структуриран вашият документ, да идентифицирате пропуснати нива на заглавия и да преброите колко заглавия от всеки тип присъстват.

Заглавията вътре в оградени кодови блокове (``` или ~~~) се игнорират, така че резултатът отразява само реалната структура на документа.

Примери

Вход:

# Getting Started

## Installation

### Prerequisites

### Steps

## Configuration

# Advanced Usage

## Plugins

Изходно дърво:

H1  Getting Started
├── H2  Installation
│   ├── H3  Prerequisites
│   └── H3  Steps
└── H2  Configuration
H1  Advanced Usage
└── H2  Plugins

Функции

  • Анализира всички H1–H6 заглавия от всеки текст на Markdown
  • Показва заглавия като интерактивно, сгъваемо дърво с контроли за разширяване/свиване
  • Пропуска заглавия вътре в оградени кодови блокове (``` и ~~~)
  • Показва брой заглавия по ниво (H1–H6) и общ брой заглавия
  • Поддържа конфигурируема начална дълбочина на разширяване

Случаи на употреба

  • Преглед на документация — Проверете, че дълъг README или страница с документация има последователна, добре подредена структура на заглавия преди публикуване.
  • SEO одит — Проверете, че съдържанието, предназначено за уеб, използва един H1 и логично вложени H2/H3, за да помогнете на краулерите на търсачките да разберат структурата на страницата.
  • Проверка на достъпността — Убедете се, че нивата на заглавия не са пропуснати, което е често срещан проблем с достъпността, отбелязан от насоките на WCAG.

Как работи

Инструментът сканира източника на Markdown ред по ред. Всеки ред, който започва с един до шест символа #, последвани от интервал, се третира като заглавие. Алгоритъм с два прохода първо събира всички заглавия по ред, след което изгражда дърво чрез проследяване на стек от отворени родителски възли — всяко ново заглавие се вложува под най-близкото предходно заглавие от по-ниско ниво.

Съвети

  • Поставете пълен файл на Markdown, включително front matter — инструментът игнорира редове без заглавия, така че YAML front matter и текст на тялото няма да повлияят на резултата.
  • Използвайте настройката Начална дълбочина на разширяване, за да автоматично свиете дълбоко вложени нива и да получите първо преглед на високо ниво.
  • Отметнете Разширяване на всички преди да изследвате голям документ, за да започнете свит и да навлезете в конкретни раздели.