A Markdown-problémák ritkán látszanak rögtön a nyers szövegben. Egy törött link, egy h2-ről h4-re ugró címsor, alt szöveg nélküli kép vagy nyitva maradt code fence sokáig rejtve maradhat, amíg a tartalom GitHubra, CMS-be vagy docs site-ra nem kerül.
A Converty Markdown-validátora élő GitHub-flavored Markdown előnézetet kombinál szerkezeti figyelmeztetésekkel. Így egyszerre látod a renderelt eredményt és azokat a pontokat, amelyeket publikálás előtt érdemes javítani.
Miért nem elég az előnézet?
Az előnézet megmutatja, hogy a tartalom helyesnek néz-e ki, de nem mindig magyarázza el, mi törékeny. Egy címsorhierarchia vizuálisan elfogadható lehet, miközben szerkezetileg rossz. Egy kép megjelenhet, de hiányozhat az alt szövege. A raw HTML pedig másképp viselkedhet a célrendszerben.
Ezért a legjobb munkafolyamat előnézetet és figyelmeztetéseket is használ. Az egyik a kimenetet mutatja, a másik a szerkezeti kockázatokat.
Publikálás előtti ellenőrzési sorrend
- Nyisd meg a Markdown-validátort.
- Illeszd be a Markdown draftot.
- Nézd meg a renderelt előnézetet.
- Ellenőrizd a headings, links, images és code fences figyelmeztetéseit.
- Végezz végső, célrendszerre figyelő átolvasást.
Ez különösen hasznos dokumentációhoz, changeloghoz, README-frissítéshez és CMS-drafthoz.
Mit érdemes nézni?
| Terület | Mi romolhat el |
|---|---|
| Címsorok | Inkonzisztens hierarchia vagy elvesző szakaszok |
| Linkek | Üres vagy törött célok |
| Képek | Hiányzó alt szöveg vagy hibás szintaxis |
| Code fences | Nyitva maradt blokkok vagy hiányzó nyelvcímkék |
| Raw HTML | Biztonságosan kezelendő vagy eltérően renderelő markup |
Ha GitHubra vagy CMS-be publikálsz, olvasd el azt is, hogyan validálhatják a dokumentációs csapatok a Markdownt GitHubra vagy CMS-be publikálás előtt.
Gyakori kérdések
Ugyanaz az előnézet, mint a végső CMS?
Nem mindig. GitHub-flavored Markdown előnézet, ezért jó preflight check, de a végső CMS-nek lehetnek saját renderelési szabályai.
Miért ellenőrizzem a címsorszerkezetet?
A következetes hierarchia javítja az olvashatóságot, az akadálymentességet és a stabil publikálást.
Mi történik a raw HTML-lel?
Az előnézet tisztított renderelést használ, hogy kipróbálhasd a raw HTML-t anélkül, hogy ellenőrizetlen kimenetben bíznál.
Kapd el a hibákat még draftban
A Markdown-problémák elkerülésének leggyorsabb módja, ha még a célrendszer előtt találod meg őket. Nyisd meg a Markdown-validátort, kombináld az előnézetet a figyelmeztetésekkel, és nézd meg a Gyakran ismételt kérdéseket, ha a Converty általános működése érdekel.
