Skip to content

Amend Markdown help page with chapter "Collapsible code block (aka spoiler)" #22448

Answered by porg
porg asked this question in Issues
Amend Markdown help page with chapter "Collapsible code block (aka spoiler)" #22448
Oct 8, 2021 · 2 answers

In 2016 there was a request “Collapsible contents (code block) in comments / spoiler tag” and a comment showed that this was possible already back then with the HTML syntax:

<details><summary>Click to expand</summary>Full content here.</details>

Instead of this valuable info being buried deep in an issue conversation, please add it to the official Syntax Reference on Github-flavored Markdown. This is linked to by the hint “Styling with Markdown is supported” below the UI for writing issues and comment, so the first stop for users informing themselves about the syntax.

And the ability to add longer code blocks without harassing your fellow readers with long scrolls is a legit syntax need, as the popularity of the issue shows.

So please to the chapter “Quoting code” add a sub-chapter “Collapsible code block (aka spoiler)” and there add this valuable information. Thanks.

Closing: Ammending the documentation with this hint will not happen.
GitHub representative @MylesBorins answered me elsewhere why not:

The reason it isn’t documented is because it isn’t GitHub flavored markdown… it is simply inline HTML. There isn’t GitHub flavored markdown specifically for details. We don’t document HTML features.

Replies

2 suggested answers

Could I please get a reaction? At least a first reaction. Thanks.

0 replies

Closing: Ammending the documentation with this hint will not happen.
GitHub representative @MylesBorins answered me elsewhere why not:

The reason it isn’t documented is because it isn’t GitHub flavored markdown… it is simply inline HTML. There isn’t GitHub flavored markdown specifically for details. We don’t document HTML features.

0 replies
Answer selected
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Issues
Labels
None yet
1 participant