A good suggestion to improve your texts in GitHub, either in Issues, PRs, README's or Wiki, is to use collapsible text. Example:
This is the Markdown code that generates the preview above:
<details>
<summary>This is the title</summary>
<p>
This is the content
</p>
</details>
Note: The two line breaks between the content is required, otherwise it won't properly generate it. Also, no tabulation.
Add this snippet to your vscode to easily expand this code:
"Collapse text": {
"prefix": "collapse",
"body": [
"<details>\n<summary>$1</summary>",
"<p>\n\n$2\n\n</p>\n</details>",
]
}
Then, when writing Markdown in vscode, type collapse
and expand.