Усі статті

Markdown: чому простий текстовий синтаксис переміг складні редактори

Markdown — це легка розмітка, яка дозволяє форматувати текст (заголовки, списки, посилання, виділення) звичайними символами, залишаючись при цьому легко читабельним у сирому вигляді — на відміну від HTML, який важко читати без рендерингу.

Основний синтаксис

  • # Заголовок — заголовки різних рівнів через кількість символів #.
  • **жирний** та *курсив* — виділення тексту.
  • [текст](url) — посилання.
  • - пункт або 1. пункт — марковані й нумеровані списки.
  • ``` — блоки коду з підсвіткою синтаксису за назвою мови.

Чому Markdown став стандартом для документації

README-файли, документація на GitHub, нотатки в багатьох застосунках — усе це Markdown. Причина популярності проста: файл читабельний і без рендерингу (на відміну від HTML чи розмітки Word), а водночас достатньо структурований, щоб автоматично перетворюватися на форматований HTML.

Конвертація в HTML і назад

Перетворення Markdown → HTML — пряме: парсер розпізнає синтаксичні конструкції й генерує відповідні теги. Зворотне перетворення HTML → Markdown складніше, бо HTML підтримує значно більше можливостей форматування, ніж базовий Markdown, тому частина розмітки (складні таблиці, вкладені стилі) може спрощуватись або губитися.

Навіщо це потрібно

  • Швидко переглянути, як Markdown-файл вигляне після рендерингу, не публікуючи його.
  • Конвертувати вміст сторінки чи документа в Markdown для збереження в системі контролю версій.
  • Підготувати HTML-контент для вставки в застосунок, що приймає лише Markdown.

Не всі «Markdown» однакові

Оригінальний Markdown Джона Ґрубера не визначає таблиці, закреслений текст чи блоки коду з мовою підсвітки — це розширення, додані пізніше різними реалізаціями. GitHub Flavored Markdown (GFM) і специфікація CommonMark по-різному трактують деякі неоднозначні випадки, тому той самий вихідний файл може відрендеритися трохи по-різному залежно від того, який парсер його обробляє.

Спробувати інструмент