Создание списков задач (Task lists) и чек-листов в Markdown

Что такое Task lists в Markdown

Списки задач (Task lists или чек-листы) — это расширение базового формата Markdown из спецификации GitHub Flavored Markdown (GFM). Оно превращает обычные маркеры списков в чек-боксы с отметками. Такие списки особенно популярны в open-source разработке (рекомендуем наш готовый шаблон README.md для GitHub).

В академической и исследовательской практике такие списки применяются повсеместно:

  • Для пошагового контроля хода физического или химического эксперимента;
  • Для отслеживания замечаний научного руководителя при подготовке диплома;
  • Для перечня реактивов, приборов и калибровочных процедур.

Markdown чек лист: синтаксис и базовые правила

Освоить Markdown чек лист синтаксис предельно просто. Чтобы элемент списка стал задачей с чек-боксом, после маркера списка (-, * или +) добавляется пробел, а затем квадратные скобки:

  • - [ ] — активная (невыполненная) задача с пустым квадратом;
  • - [x] (или - [X] ) — завершенная задача с установленной отметкой.
Markdown
### План подготовки измерительного стенда

- [x] Проверить контур заземления прибора
- [x] Откалибровать термопару при температуре 20°C
- [ ] Выполнить серию из 10 контрольных измерений
- [ ] Зафиксировать результаты в электронном журнале

В превью Labkeeper галочки отображаются, но кликом не переключаются: чтобы отметить пункт, замените в тексте [ ] на [x]. Отмечать пункты кликом позволяет, например, GitHub — в описаниях issues и pull requests.

Вложенные списки задач и группировка

Сложные исследовательские этапы легко разбивать на подзадачи. Для создания вложенного уровня добавьте перед дефисом отступ в 2 или 4 пробела:

Markdown
- [ ] Этап 1: Подготовка исследуемых образцов
  - [x] Взвешивание навесок на аналитических весах
  - [ ] Растворение в буферном растворе pH 7,4
- [ ] Этап 2: Спектрофотометрия
  - [ ] Прогрев спектрофотометра в течение 15 минут
  - [ ] Измерение оптической плотности контрольной кюветы

Форматирование внутри чек-листов (код, формулы, ссылки)

Внутри строк чек-листа сохраняются все возможности форматирования Markdown: ссылки, полужирный шрифт, теги инлайн-кода (детальный разбор оформления листингов смотрите в статье о подсветке синтаксиса кода в Markdown) и даже математические выражения LaTeX:

Markdown
- [x] Установить библиотеку `scipy` версии не ниже **1.10**
- [x] Проверить критерий сходимости $R^2 \ge 0{,}98$
- [ ] Скачать методические указания по [ссылке на кафедральный портал](https://example.com/metodichka.pdf)

Список задач Markdown с галочками: пример для лабораторной работы

Оформляя отчет по лабораторной работе, удобно добавить список задач Markdown с галочками в качестве контрольного листа допуска к выполнению эксперимента:

Markdown
## Контрольный лист допуска к эксперименту

- [x] Вводный инструктаж по технике безопасности пройден
- [x] Теоретический расчет погрешностей выполнен
- [ ] Схема измерений собрана и одобрена преподавателем
- [ ] Стартовое напряжение источника питания выставлено на $U = 12\text{ В}$
- [ ] Показания амперметра внесены в чистовой протокол

В Markdown-проекте Labkeeper кнопка «Сохранить в PDF» открывает печать браузера, и чек-боксы попадают на лист такими же, как в превью. Чек-листы — возможность Markdown-проекта: в LaTeX-проекте Pandoc с commonmark_x оставляет пункты обычным списком с текстом [x] и [ ]. Пакет amssymb для этого не нужен, и сегмент собирается.

Типичные ошибки при оформлении

  • Отсутствие пробела между скобками: Конструкция - [] не будет распознана. Внутри скобок обязательно должен быть ровно один пробел: - [ ].
  • Слитное написание с дефисом: -[ ] или - [ ]Текст без пробелов приведет к поломке разметки списка.
  • Русская буква «х»: Отметка выполнения требует исключительно латинской буквы: - [x] или - [X].

Практические советы

1

Зачеркивание для отмененных пунктов

Если пункт плана был отменен, используйте двойную тильду: - [x] ~~Предварительный прогрев реактора~~ (отменено регламентом).

2

Автоматический трекинг выполнения на GitHub

Если чек-лист стоит в описании issue или pull request на GitHub, сайт показывает индикатор готовности (например, 4 of 6 tasks) в списке задач. В обычных файлах репозитория, например в README.md, чек-лист отображается без такого счетчика.

Попробуйте прямо сейчас

Контролируйте ход исследований в Labkeeper

Онлайн-редактор с поддержкой списков задач Task lists, вложенных подпунктов, формул MathJax и сохранения отчета в PDF.

Другие статьи