Skip to content

Instantly share code, notes, and snippets.

@lslezak
Last active April 18, 2019 10:08
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save lslezak/cc9a7fd567ce8df01d689f86d0c66329 to your computer and use it in GitHub Desktop.
Save lslezak/cc9a7fd567ce8df01d689f86d0c66329 to your computer and use it in GitHub Desktop.
Markdown Tricks

Markdown

Here are some Markdown formatting tricks. Please note that it depends on the actual markdown renderer, some feature might work only in specific environments.

All these tricks work at Github, but might not work elsewhere.

Collapsed Details at GitHub

If you have very long log or details you might make them collapsible to save some space. You can expand them just by clicking the summary line with the black triangle on the left.

<details>
 <summary>Displayed summary</summary>

Hidden details, by default collapsed.  
You can use **markdown** here as well.

</details>

is rendered as

Displayed summary

Hidden details, by default collapsed.
You can use markdown here as well.

Screenshots

If you want to have several screenshots on the same line you can use a table:

Product and language selection License
Multiple products - selection Multiple products -license

Google Charts

If you need to render some fancy stuff like math formulas, bubbles or graphs you might you some image rendering servise like Google Charts, see the documentation:

Examples

Math Formulas

Bubbles

Colored Text

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment