Синтаксис Markdown: шпаргалка за завданнями

Markdown це звичайний текст із кількома простими позначками. Ця сторінка є шпаргалкою. Знайди, що ти хочеш зробити, скопіюй приклад і працюй далі.

Деякі позначки працюють скрізь. Деякі працюють лише в певних застосунках. Кожен розділ вказує, до якого виду вони належать:

  • Базові: частина CommonMark, основного стандарту. Працюють майже скрізь.
  • GFM: розширення в GitHub Flavored Markdown, яке доповнює CommonMark. Його підтримує більшість застосунків.
  • Функція GitHub: широко використовується, але не входить до жодної зі специфікацій. Перевір свій застосунок.

Заголовки (базові)

Почни рядок з однієї–шести позначок #, а потім постав пробіл. Більше позначок # означає менший заголовок.

# Title
## Section
### Subsection

Пробіл важливий. Сім позначок # не є заголовком.

Абзаци й розриви рядків (базові)

Порожній рядок починає новий абзац. Одиничний перенос рядка всередині абзацу не розриває рядок. Текст тече далі.

Щоб зробити розрив рядка без нового абзацу, заверши рядок двома пробілами або зворотною скісною рискою:

First line\
Second line

Жирний, курсив і закреслення

*italic* or _italic_
**bold** or __bold__
***bold and italic***
~~strikethrough~~

Курсив і жирний шрифт є базовими. Закреслення належить до GFM. Використовуй зірочки, якщо позначка стоїть усередині слова, бо _ усередині слова не працює.

Списки

- Apples
- Bananas
  - Green ones
  - Yellow ones

1. Wake up
2. Make tea
3. Read

- [ ] Write the draft
- [x] Send the draft

Маркери можуть починатися з -, + або *. Нумеровані списки використовують число та . або ). Перше число визначає, з чого починається список.

Щоб вкласти список, зроби відступ у внутрішнього списку так, щоб він вирівнювався з текстом пункту вище. Для - Bananas це два пробіли.

Маркери й нумерація є базовими. Списки завдань, тобто прапорці [ ] і [x], належать до GFM.

Посилання

[PilcrowMD](https://pilcrowmd.com "Optional title")
<https://pilcrowmd.com>
https://pilcrowmd.com

Перше є рядковим посиланням: текст у квадратних дужках, адреса в круглих. Друге є автопосиланням в кутових дужках. Обидва є базовими.

Третє є простою адресою без позначок. CommonMark не перетворює її на посилання. GFM перетворює, якщо адреса починається з http://, https:// або www..

Посилання на заголовок

Щоб перейти до заголовка в тому самому файлі, зроби посилання на його якір:

## My first section

[Go to the section](#my-first-section)

Посилання є звичайним рядковим посиланням. Якір на GitHub утворюється з тексту заголовка: малі літери, пробіли замінюються дефісами, інші розділові знаки вилучаються. До другого заголовка з таким самим текстом додається -1. Інші застосунки можуть утворювати якорі так само, але це правило GitHub, тож перевір.

Зображення

Як посилання, але зі знаком ! попереду:

![A red apple on a table](apple.jpg)

Текст у квадратних дужках це опис (альтернативний текст). Синтаксис зображень є базовим.

Цитати (базові)

Починай кожен рядок зі знака >:

> The best way to learn is to try.

Код

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

Run `npm test` before you commit.

Щоб показати зворотну лапку всередині коду, візьми код у подвійні зворотні лапки.

Для блока використовуй огородження з трьох зворотних лапок. Після відкривного огородження напиши назву мови:

```python
print("Hello")
```

Огородження можна робити й із трьох тильд ~~~. Назва мови необов’язкова. Застосунки використовують її, щоб розфарбувати код. Усе це базове.

Горизонтальна лінія (базова)

Три або більше -, * чи _ в окремому рядку:

---

Залиш порожній рядок над ---. Просто під рядком тексту вона натомість перетворить цей текст на заголовок.

Таблиці (GFM)

Таблиця потребує рядка заголовка, рядка з дефісів і рядків даних:

| Fruit  | Price |
|--------|-------|
| Apple  | 1.20  |

У таблиць є й інші правила, як-от вирівнювання та екранування вертикальної риски. Див. Таблиці в Markdown: як їх писати й читати.

Екранування: показати позначку як текст (базове)

Постав зворотну скісну риску перед позначкою, щоб показати її як звичайний текст:

\*not italic\*

Так можна екранувати будь-який розділовий знак. Зворотні скісні риски всередині коду не працюють.

Виноски (функція GitHub)

This claim needs a source.[^1]

[^1]: Here is the source.

Виносок немає в CommonMark чи специфікації GFM. GitHub їх підтримує. Текст виноски з’являється внизу сторінки, де б його не було написано у файлі. GitHub не підтримує виноски у вікі.

Виділені блоки (функція GitHub)

Виділений блок це цитата з міткою в першому рядку:

> [!NOTE]
> Useful information the reader should know.

Типи: NOTE, TIP, IMPORTANT, WARNING і CAUTION. Їх немає в жодній зі специфікацій. Використовуй їх помірно.

Читання Markdown

У звичайному текстовому редакторі всі ці позначки лишаються видимими. Засіб читання Markdown перетворює їх на чисту сторінку.

PilcrowMD показує таблиці, виноски, виділені блоки в стилі GitHub і посилання, що переходять до заголовка, на Android і Mac. На Mac він також показує списки завдань.

Поширені запитання

Який Markdown вивчати першим? Базові позначки: заголовки, жирний шрифт, курсив, списки, посилання, код і цитати. Вони працюють у кожному застосунку Markdown. Далі додай таблиці та списки завдань, бо більшість застосунків підтримують GFM.

Чому мій Markdown виглядає інакше в іншому застосунку? Застосунки дотримуються різних правил. CommonMark є основою, GFM доповнює його, а деякі можливості, як-от виноски та виділені блоки, не входять до жодного з них. Якщо позначка не працює, застосунок, імовірно, її не підтримує.

Чи обов’язково ставити пробіли після # і -? Так. Пиши # Title і - Item. Без пробілу рядок лишається звичайним текстом.

Також для Mac: PilcrowMD для Mac (бета)