Markdown за 5 хвилин
Ви, мабуть, вже використовували Markdown, не підозрюючи про це. Чи не набирали ви **жирний** у повідомленні Slack? Писали README на GitHub? Форматували пост на Reddit? Це і є Markdown.
Markdown — це легкий спосіб форматувати простий текст за допомогою простих символів. Замість того щоб натискати кнопки на панелі інструментів для жирного, курсиву, заголовків і списків, ви вводите кілька символів, що вказують на потрібне форматування. Він був створений у 2004 році Джоном Грубером та Аароном Шварцом і відтоді став стандартною мовою форматування для розробників, письменників та всіх, хто працює з текстом в інтернеті.
Навіщо існує Markdown
До Markdown форматування тексту для вебу означало написання HTML. Щоб виділити слово жирним, потрібно було ввести <strong>жирний</strong>. Щоб створити список, потрібні були <ul><li>елемент</li></ul>. HTML потужний, але багатослівний і важко читається в сирому вигляді.
Markdown вирішує цю проблему, надаючи зрозумілу людині скорочену нотацію. Сирий текст легко читається ще до рендерингу. Відформатований результат чистий і професійний. Ви отримуєте найкраще з обох світів: читабельний вихідний текст і відшліфований результат.
Чи знали ви? Філософія дизайну Markdown полягає в тому, що сирий текст має бути «придатним для публікації як є, у вигляді простого тексту, без вигляду розміченого тегами або інструкціями форматування». Саме тому синтаксис Markdown використовує символи, що візуально відображають форматування, яке вони створюють.
Основний синтаксис
Ось усе, що потрібно знати для продуктивної роботи з Markdown.
Заголовки
Використовуйте символи решітки (#) для створення заголовків. Більше решіток — менший заголовок.
# Заголовок 1 (найбільший)
## Заголовок 2
### Заголовок 3
#### Заголовок 4
Жирний і курсив
Оберніть текст в зірочки або підкреслення:
**жирний текст**
*курсивний текст*
***жирний і курсивний***
Списки
Ненумеровані списки використовують дефіси, зірочки або знаки плюс. Нумеровані списки використовують цифри.
- Перший елемент
- Другий елемент
- Третій елемент
1. Перший крок
2. Другий крок
3. Третій крок
Посилання
Квадратні дужки для тексту, круглі дужки для URL:
[Натисніть тут](https://example.com)
Зображення
Як посилання, але зі знаком оклику спереду:
Цитати
Використовуйте знак «більше ніж»:
> Це цитата. Вона буде з відступом та іншим стилем оформлення.
Код
Зворотні лапки для вбудованого коду, потрійні зворотні лапки для блоків коду:
Використовуйте функцію `print()` для виведення тексту.
Для багаторядкових блоків коду використовуйте потрійні зворотні лапки з необов'язковим ідентифікатором мови:
```python
def hello():
print("Hello, world!")
```
Горизонтальні лінії
Три або більше дефісів, зірочок або підкреслень:
---
Таблиці
Використовуйте вертикальні риски та дефіси:
| Ім'я | Роль | Місто |
| --- | --- | --- |
| Аліса | Розробник | Берлін |
| Боб | Дизайнер | Лондон |
Де використовується Markdown
Markdown є всюди:
Розробка програмного забезпечення
- GitHub, GitLab, Bitbucket: README, задачі, pull-запити та документація — усе пишеться на Markdown.
- Stack Overflow: Питання та відповіді використовують форматування Markdown.
- Документація коду: Багато генераторів документації (Docusaurus, MkDocs, Jekyll) використовують Markdown як вихідний формат.
Комунікація
- Slack: Підтримує підмножину Markdown для форматування повідомлень.
- Discord: Використовує Markdown для жирного, курсиву, блоків коду та іншого.
- Reddit: Пости та коментарі форматуються за допомогою Markdown.
Написання та публікації
- Блоги: Багато генераторів статичних сайтів використовують файли Markdown як джерела контенту.
- Книги: Деякі видавничі інструменти приймають рукописи у форматі Markdown.
- Нотатки: Програми на кшталт Obsidian, Notion, Bear і Typora побудовані навколо Markdown.
Документація
- Технічна документація: API-документація, посібники користувача та вікі зазвичай використовують Markdown.
- Внутрішні бази знань: Багато команд використовують вікі на основі Markdown.
Порада Ви можете переглядати та практикувати Markdown прямо зараз, безкоштовно, у вашому браузері: Писати на Markdown. Бачте відформатований результат у реальному часі під час введення.
Варіанти Markdown
Одна важлива річ: існують різні «варіанти» Markdown. Основний синтаксис скрізь однаковий, але деякі платформи додають розширення:
| Варіант | Додаткові можливості | Використовується |
|---|---|---|
| CommonMark | Сувора специфікація | Загальний стандарт |
| GitHub Flavored Markdown (GFM) | Списки завдань, таблиці, закреслення, автопосилання | GitHub |
| MultiMarkdown | Виноски, цитати, метадані | Академічне письмо |
| R Markdown | Вбудований код R, аналіз даних | Data science |
Відмінності здебільшого стосуються розширених функцій. Основи (заголовки, жирний, курсив, списки, посилання, зображення, код) скрізь однакові.
Поширені помилки
Забуті порожні рядки
Markdown вимагає порожній рядок до і після багатьох елементів. Заголовок потребує порожнього рядка перед собою. Список потребує порожнього рядка до і після. Забуті порожні рядки — найпоширеніша причина проблем з рендерингом.
Непослідовні маркери списків
Змішування -, * і + в одному списку може спричинити непередбачуваний рендеринг. Оберіть один варіант і дотримуйтесь його.
Пробіли після символів
Деякі Markdown-процесори вимагають пробілу після # у заголовках та після - у списках. Завжди включайте пробіл для надійності.
# Правильний заголовок
#Неправильний заголовок
- Правильний елемент списку
-Неправильний елемент списку
Увага Markdown не підтримує всі потреби форматування. Якщо вам потрібні складні макети, кольоровий текст, точна типографіка або документи, готові до друку, вам може знадобитися HTML, LaTeX або текстовий редактор. Markdown найкраще підходить для структурованого, орієнтованого на текст контенту.
Чому варто вивчити Markdown
Markdown потребує п'яти хвилин для вивчення і економить години з часом. Знаючи його, ви зможете:
- Писати документацію, яка красиво відображається на GitHub
- Форматувати повідомлення у Slack та Discord, не торкаючись миші
- Вести структуровані нотатки, які переносяться між програмами
- Створювати пости в блозі та веб-контент із простих текстових файлів
- Співпрацювати над текстовими документами без проблем сумісності форматів
Співвідношення інвестицій до окупності — одне з найкращих у всьому технологічному світі.
Починайте писати на Markdown прямо зараз:
Безкоштовно, у вашому браузері, з переглядом у реальному часі під час введення.