Создание списков задач (Task lists) и чек-листов в Markdown
Что такое Task lists в Markdown
Списки задач (Task lists или чек-листы) — это интерактивное расширение базового формата Markdown, утвержденное стандартом GitHub Flavored Markdown (GFM). Они позволяют превращать стандартные маркеры списков в кликабельные чек-боксы. Такие списки особенно популярны в open-source разработке (рекомендуем наш готовый шаблон README.md для GitHub).
В академической и исследовательской практике такие списки применяются повсеместно:
- Для пошагового контроля хода физического или химического эксперимента;
- Для отслеживания замечаний научного руководителя при подготовке диплома;
- Для перечня реактивов, приборов и калибровочных процедур.
Markdown чек лист: синтаксис и базовые правила
Освоить Markdown чек лист синтаксис предельно просто. Чтобы элемент списка стал задачей с чек-боксом, после маркера списка (-, * или +) добавляется пробел, а затем квадратные скобки:
- [ ]— активная (невыполненная) задача с пустым квадратом;- [x](или- [X]) — завершенная задача с установленной отметкой.
### План подготовки измерительного стенда
- [x] Проверить контур заземления прибора
- [x] Откалибровать термопару при температуре 20°C
- [ ] Выполнить серию из 10 контрольных измерений
- [ ] Зафиксировать результаты в электронном журнале
В большинстве современных редакторов, включая Labkeeper и веб-интерфейс GitHub, такие чек-листы интерактивны: вы можете отмечать пункты кликом мыши прямо в режиме чтения документа.
Вложенные списки задач и группировка
Сложные исследовательские этапы легко разбивать на подзадачи. Для создания вложенного уровня добавьте перед дефисом отступ в 2 или 4 пробела:
- [ ] Этап 1: Подготовка исследуемых образцов
- [x] Взвешивание навесок на аналитических весах
- [ ] Растворение в буферном растворе pH 7.4
- [ ] Этап 2: Спектрофотометрия
- [ ] Прогрев спектрофотометра в течение 15 минут
- [ ] Измерение оптической плотности контрольной кюветы
Форматирование внутри чек-листов (код, формулы, ссылки)
Внутри строк чек-листа сохраняются все возможности форматирования Markdown: ссылки, полужирный шрифт, теги инлайн-кода (детальный разбор оформления листингов смотрите в статье о подсветке синтаксиса кода в Markdown) и даже математические выражения LaTeX:
- [x] Установить библиотеку `scipy` версии не ниже **1.10**
- [x] Проверить критерий сходимости $R^2 \ge 0.98$
- [ ] Скачать методические указания по [ссылке на кафедральный портал](https://labkeeper.io)
Список задач Markdown с галочками: пример для лабораторной работы
Оформляя отчет по лабораторной работе, удобно добавить список задач Markdown с галочками в качестве контрольного листа допуска к выполнению эксперимента:
## Контрольный лист допуска к эксперименту
- [x] Вводный инструктаж по технике безопасности пройден
- [x] Теоретический расчет погрешностей выполнен
- [ ] Схема измерений собрана и одобрена преподавателем
- [ ] Стартовое напряжение источника питания выставлено на $U = 12\text{ В}$
- [ ] Показания амперметра внесены в чистовой протокол
При экспорте отчета в PDF в редакторе Labkeeper все чек-боксы преобразуются в аккуратные типографические рамки с четкими векторными галочками, которые идеально смотрятся на распечатанном бланке отчета.
Типичные ошибки при оформлении
- Отсутствие пробела между скобками: Конструкция
- []не будет распознана. Внутри скобок обязательно должен быть ровно один пробел:- [ ]. - Слитное написание с дефисом:
-[ ]или- [ ]Текстбез пробелов приведет к поломке разметки списка. - Русская буква «х»: Отметка выполнения требует исключительно латинской буквы:
- [x]или- [X].
Практические советы
Зачеркивание для отмененных пунктов
Если пункт плана был отменен, используйте двойную тильду: - [x] ~~Предварительный прогрев реактора~~ (отменено регламентом).
Автоматический трекинг выполнения на GitHub
Если файл сохраняется на GitHub или GitLab, чек-листы автоматически формируют процентный индикатор готовности задачи (например, 4 of 6 tasks) в превью репозитория.