Mis on Markdowni pealkirjade hierarhia?

Markdowni pealkirjad määratakse sümboliga # — üks # H1 jaoks, kaks H2 jaoks, kuni kuus H6 jaoks. Need moodustavad dokumendi struktuurse aluse, sarnaselt sisukorraga. Hästi struktureeritud dokument kasutab pealkirju loogilises, pesastatud järjekorras: H1 ülemise taseme pealkirjana, H2 põhiosadele, H3 alamosadele ja nii edasi.

Kui pealkirjad on valesti järjekorras — näiteks H2-st otse H4-le hüppamine — see rikub semantilist ülesehitust ja võib kahjustada juurdepääsetavust (ekraanilugejad sõltuvad pealkirjade järjekorrast) ja SEO-t (otsingumootori kasutavad pealkirju sisu hierarhia mõistmiseks). Hierarhia visualiseerimine muudab nende probleemide tuvastamise avaldamisele eelnevalt lihtsaks.

Tööriista kirjeldus

See tööriist analüüsib Markdowni teksti ja kuvab kõik #-põhised pealkirjad interaktiivse, kokkupandava puuna. Näete ühe pilguga, kuidas teie dokument on struktureeritud, saate tuvastada vahele jäänud pealkirjade tasemeid ja lugeda, kui palju iga tüüpi pealkirju on olemas.

Pealkirjad piiratud koodiplokis (``` või ~~~) jäetakse vahele, nii et väljund peegeldab ainult tegelikku dokumendi struktuuri.

Näited

Sisend:

# Getting Started

## Installation

### Prerequisites

### Steps

## Configuration

# Advanced Usage

## Plugins

Väljundpuu:

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

Funktsioonid

  • Analüüsib kõiki H1–H6 pealkirju mis tahes Markdowni tekstist
  • Renderdab pealkirjad interaktiivse, kokkupandava puuna laiendamise/ahendamise juhtelementidega
  • Jätab vahele pealkirjad piiratud koodiplokis (``` ja ~~~)
  • Näitab taseme kohta pealkirjade arvu (H1–H6) ja pealkirjade koguarvu
  • Toetab konfigureeritavat algset laiendamise sügavust

Kasutamise juhtumid

  • Dokumentatsiooni ülevaatus — Kontrollige, et pikk README või dokumentatsioonileht omab ühtselt struktureeritud pealkirjade struktuuri enne avaldamist.
  • SEO auditeerimine — Veenduge, et veebi jaoks mõeldud sisu kasutab üht H1-d ja loogilist H2/H3 pesastamist, et aidata otsingumootori robotitel lehte struktuuri mõista.
  • Juurdepääsetavuse kontrollimine — Veenduge, et pealkirjade tasemeid ei vahele jäeta, mis on WCAG-i suuniste poolt märgitud levinud juurdepääsetavuse probleem.

Kuidas see toimib

Tööriist skaneerib Markdowni lähteteksti rida realt. Iga rida, mis algab ühe kuni kuue # märgiga, millele järgneb tühik, käsitletakse pealkirjana. Kahepassiline algoritm kogub kõigepealt kõik pealkirjad järjekorras, seejärel koostab puu, jälgides avatud ematsõlmede virna — iga uus pealkiri pesastatakse lähima eelneva madalamate tasemete pealkirja alla.

Näpunäited

  • Kleepige täielik Markdowni fail, sealhulgas esiosa — tööriist ignoreerib mittepealkirjade ridu, nii et YAML esiosa ja kehatekst ei mõjuta väljundit.
  • Kasutage Algse laiendamise sügavuse sätet, et automaatselt ahendada sügavate pesastamiste tasemeid ja saada kõigepealt kõrge taseme ülevaade.
  • Tühjendage Laienda kõik enne suure dokumendi uurimist, et alustada ahendatult ja süveneda konkreetsetesse osadesse.