Suppose you're opening an issue and there's a lot noisey logs that may be useful.
Rather than wrecking readability, wrap it in a <details>
tag!
<details>
<summary>Summary Goes Here</summary>
...this is hidden, collapsable content...
</details>
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details
Click to expand!
def func():
return 'hello, world!'
root
bin
nest1
a b c
nest2
a b c
file1 file2 file3
boot
x y z
dev
p q r
etc
e t c
home
me you everyone
lib
lib er ate
To add to @cdstanford's comment above ... based on my experiments, mixing markdown formatting into details and summary is a mixed bag. And I am specifically talking about what ends up being presented on github pages with
markdown: kramdown
Expand/Collapse WORKS in general as a standalone, separate from any other markdown in the
.md
fileExpand/Collapse WORKS when Nesting details inside a markdown bullet:
Expand/Collapse Does NOT work if details need to be a sub-bullet:
Formatting Does NOT work if details need to bold or code formatting: