Skip to main content

Упорядочение сведений с помощью свернутых разделов

Можно упростить разметку Markdown, создав свернутый раздел с тегом <details>.

Кто может использовать эту функцию?

Markdown можно использовать в веб-интерфейсе GitHub .

Создание свернутого раздела

Можно временно скрыть разделы Markdown, создав свернутый раздел, который читатель может развернуть. Например, если вы хотите включить технические сведения в комментарий к проблеме, которые могут быть нерелевантными или интересными каждому читателю, эти сведения можно поместить в свернутый раздел.

Все Markdown в <details> блоке будут свернуты, пока читатель не щелкает для расширения сведений.

В блоке <details> используйте <summary> тег, чтобы читатели знали, что внутри. Метка отображается справа от октикона "треугольник-правый" aria-label="Значок правого треугольника" %}.

<details>

<summary>Tips for collapsed sections</summary>

### You can add a header

You can add text within a collapsed section.

You can add an image or a code block, too.

```ruby
   puts "Hello World"
```

</details>

Markdown внутри <summary> метки будет свернут по умолчанию:

Снимок экрана: Markdown выше на этой странице, как показано на GitHub, где показана стрелка вправо и заголовок "Советы по свернутых разделам".

После нажатия кнопки октикона "треугольник-справа" aria-label="Значок правого треугольника" %}, будут развернуты сведения:

Снимок экрана: Markdown выше на этой странице, как показано на GitHub. Свернутый раздел содержит заголовки, текст, изображения и блоки кода.

При необходимости, чтобы открыть раздел по умолчанию, добавьте open атрибут в <details> тег:

<details open>

Дополнительные материалы