У цій статті
Що таке валідація Markdown?
Валідація Markdown перевіряє, чи дотримується документ правильного синтаксису та чи коректно відображатиметься на різних платформах.
Документація та файли README все частіше пишуться в Markdown. Валідація забезпечує узгоджене відображення.
Як працює валідатор Markdown
Валідатор Markdown від CheckTown аналізує контент та перевіряє помилки форматування.
- Перевірка синтаксису — перевіряє рівні заголовків, форматування списків та синтаксис посилань
- Аналіз структури — виявляє проблеми ієрархії заголовків
- Перевірка посилань — валідує синтаксис inline та reference посилань
Спробуйте безкоштовно — реєстрація не потрібна
Перевірити Markdown →Поширені помилки Markdown
Помилки Markdown тонкі — вони просто відображаються неправильно.
- Відсутні порожні рядки — Markdown вимагає порожніх рядків перед заголовками та списками
- Непослідовні маркери списків — змішування символів може збивати парсери
- Порушений синтаксис посилань — відсутня дужка перетворює посилання на текст
Коли використовувати валідацію Markdown
Валідація найцінніша, коли документи повинні коректно відображатися на кількох платформах.
- Документація — валідуйте README перед пушем
- Контент блогу — перевіряйте пости перед публікацією
- Стандарти команди — забезпечуйте стиль через CI
Поширені запитання
Яку специфікацію використовує валідатор?
Валідатор дотримується CommonMark, підтримуваної GitHub та GitLab.
Чи підтримується GFM?
Так. Розширення GFM розпізнаються, включаючи таблиці та блоки коду.
Чи виявляються непрацюючі посилання?
Валідатор перевіряє синтаксис посилань, але не перевіряє доступність URL.
Пов'язані інструменти
Валідація HTML: повний посібник з чистої розміткиДізнайтеся, як працює валідація HTML та чому вона важлива для SEO та доступності.Читати статтю → Валідація SQL: повний посібник з перевірки синтаксису запитівДізнайтеся, як працює валідація SQL та як виявляти помилки синтаксису.Читати статтю → Валідація XML: посібник з правильно сформованих документівДізнайтеся, як працює валідація XML та яка різниця між well-formed та валідним XML.Читати статтю →