Спойлеры и скрываемый текст в Markdown (теги details и summary)

Зачем нужны спойлеры в документации и конспектах

В объемных учебных пособиях, отчетах и лабораторных руководствах часто нужно спрятать громоздкие листинги кода, длинные дампы логов или ответы на вопросы самопроверки (подобные спойлеры также активно применяются в шаблонах GitHub README с бейджами и спойлерами), чтобы читатель не пролистывал десятки экранов скролла.

Скрытый текст details в Markdown: базовый синтаксис

Чтобы организовать скрытый текст details markdown, используется нативная пара HTML5-тегов <details> и <summary>:

Markdown / HTML
<details>
  <summary>Нажмите, чтобы увидеть подсказку к задаче №3</summary>

  Для решения используйте закон сохранения импульса в проекции на ось OX:
  $m_1 v_1 + m_2 v_2 = (m_1 + m_2) u$
</details>

Заголовок внутри <summary> остается видимым всегда и снабжается кликабельной стрелкой раскрытия, а основной контент прячется до нажатия мыши.

Как сделать спойлер в Markdown раскрытым по умолчанию

Разбирая вопрос, как сделать спойлер в markdown сразу развернутым при загрузке документа, достаточно добавить атрибут open: <details open>. Пользователь сможет свернуть блок, если он ему мешает.

Вложенность кода, списков и формул внутри спойлера

Обязательно делайте пустую строку после закрывающего тега </summary>! Если пустой строки нет, парсер может воспринять разметку Markdown (решетки заголовков, формулы TeX или сноски в тексте Markdown) как простой текст.

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

1

Поведение при экспорте в PDF

При экспорте документа в PDF спойлеры автоматически раскрываются, чтобы ценная информация не была потеряна на бумажном носителе.

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

Оформляйте удобные методические материалы в Labkeeper

Онлайн-редактор с поддержкой раскрывающихся спойлеров, интерактивных блоков и экспортом в печатный PDF.

LaTeX editor screenshot
  • Полновесная компиляция: Получайте PDF профессионального качества с помощью встроенного LaTeX-компилятора.
  • 60 секунд на выполнение: Работайте со сложными документами без ограничений — лимит времени компиляции в разы выше, чем в аналогичных сервисах.
  • Умная конвертация: Любые вычислительные формулы автоматически преобразовываются в красивый LaTeX
  • Гибридный синтаксис: Используйте легковесные вставки Markdown прямо в сложном LaTeX-коде для ускорения работы.
bg

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