Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.22 KB

organizing-information-with-collapsed-sections.md

File metadata and controls

49 lines (33 loc) · 2.22 KB
title intro versions redirect_from shortTitle
Organizing information with collapsed sections
You can streamline your Markdown by creating a collapsed section with the `<details>` tag.
fpt ghes ghec
*
*
*
/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections
Collapsed sections

Creating a collapsed section

You can temporarily obscure sections of your Markdown by creating a collapsed section that the reader can choose to expand. For example, when you want to include technical details in an issue comment that may not be relevant or interesting to every reader, you can put those details in a collapsed section.

Any Markdown within the <details> block will be collapsed until the reader clicks {% octicon "triangle-right" aria-label="The right triangle icon" %} to expand the details.

Within the <details> block, use the <summary> tag to let readers know what is inside. The label appears to the right of {% octicon "triangle-right" aria-label="The right triangle icon" %}.

<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>

The Markdown inside the <summary> label will be collapsed by default:

Screenshot of the Markdown above on this page as rendered on {% data variables.product.prodname_dotcom %}, showing a right-facing arrow and the header "Tips for collapsed sections."

After a reader clicks {% octicon "triangle-right" aria-label="The right triangle icon" %}, the details are expanded:

Screenshot of the Markdown above on this page as rendered on {% data variables.product.prodname_dotcom %}, indicating that a collapsed section can contain headers, sentences of text, images, and code blocks.

Further reading