Як додати прапорець у Markdown:синтаксис списку завдань і приклади.

Синтаксис списку завдань у Markdown

Список завдань — звичайний список, пункти якого починаються з маркера прапорця. Він складається з трьох частин:

1. Маркер списку

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

2. Прапорець у квадратних дужках

   [ ] з одним пробілом усередині — порожній прапорець. [x] — позначений; велика [X] теж підходить. Більше нічого між дужками бути не повинно.

3. Пробіл і текст

   Без пробілу після ] рядок лишається звичайним текстом із дужками.

- [x] Draft the spec
- [x] Add the edge cases
- [ ] Get a review
- [ ] Hand it to the agent

Так це бачить читач:

• Накидати специфікацію
• Додати крайні випадки
• Отримати рев'ю
• Передати агентові

Вкладені прапорці

Зробіть відступ у завдання під іншим завданням, і вийде підзавдання. У більшості рендерерів вистачає двох пробілів, найнадійніше чотири:

- [ ] Release 2.0
    - [x] Update the changelog
    - [ ] Tag the build
    - [ ] Announce it
- [ ] Plan 2.1

В одному списку можна змішувати завдання зі звичайними пунктами, а абзац, код чи цитату під завданням можна розмістити, зсунувши їх так, щоб вони збігалися з текстом завдання. Батьківський прапорець сам не позначається, коли готові підзавдання: його позначаєте ви.

Де відображаються прапорці Markdown

• GitHub показує списки завдань як прапорці в Markdown-файлах, задачах (issues), pull request і коментарях. В issue чи pull request прапорець можна позначити просто на сторінці, і GitHub сам змінить текст.
• Markdown-застосунки, що дотримуються GFM, теж їх показують. У DotMD вони виглядають як прапорці в режимі читання. Там вони лише для читання: щоб позначити прапорець, змініть у рядку [ ] на [x].
• Мінімальні парсери, які знають лише вихідний Markdown або CommonMark, показують текст як є, з дужками. Він усе одно читається як список справ, тільки без прапорців.

Якщо ви пишете в DotMD Editor, то Enter наприкінці завдання починає наступне з порожнього - [ ], і можна продовжувати набирати пункти.

Галочка в Markdown без списку завдань

Коли галочка потрібна в таблиці чи в реченні, а не в списку, наберіть сам символ. Символи Unicode — це текст, тому вони видимі в будь-якому Markdown-застосунку:

GitHub також розуміє шорткоди емодзі, наприклад :white_check_mark:. Це можливість GitHub: в іншому застосунку вони можуть відобразитися як звичайний текст, тому якщо файл читатимуть деінде, краще використати сам символ.

Списки завдань у планах і специфікаціях

Списки завдань потрібні не лише для застосунків зі справами. План чи специфікація в Markdown часто закінчується списком того, що лишилося зробити, і кожен крок легко перевірити на окремому рядку:

## Tasks
- [x] Add the settings screen
- [ ] Write the migration
- [ ] Update the tests
- [ ] Update the docs

Нехай кожне завдання буде однією дією, яку можна завершити й перевірити. Для кожної групи використовуйте заголовок, а підзавдання вкладайте лише тоді, коли вони належать одному батьківському.

Чому замість прапорців видно дужки

• Немає пробілу після дужки: - [x]Done — не завдання. Пишіть - [x] Done.
• Пробіли всередині дужок: [ ] з двома пробілами або [ x ] — звичайний текст.
• Немає маркера списку: рядок, що починається лише з [ ], не є пунктом списку.
• Текст, що починається з дужки. У документації GitHub радять екранувати дужку: пишіть - [ ] \(Optional) Test it.
• Рендерер не знає GFM. Тоді ви побачите дужки, що б не набрали.

Щоб перевірити, як виглядає план із завданнями, відкрийте файл у DotMD, де читання безкоштовне. Специфікації та плани часто пишуть списками завдань, а прапорці допомагають швидко переглянути довгий список.

Питання про прапорці в Markdown

Інші запитання