GitHub Markdown Tricks

github_markdown.md

Summary and details

Click to see the details

The details...

Click to hide the details

The details...

Warnings and notes etc

Warning

This is a warning

Note

This is a note

Important

This is important

Tip

Only if the service was good

Caution

Be careful..

Aesthetic text (aka scientific notation)

$This\ is\ nice$ $e=mc^2$

Footnotes

This has a footnote ¹ below

Console

$ grep foo bar
grep: bar: No such file or directory

Markdown

### Summary and details

<details closed="See the details">
    <summary>Click to see the details</summary>
    The details...
</details>

<details open="Hide the details">
    <summary>Click to hide the details</summary>
    The details...
</details>

### Warnings and notes etc

> [!Warning]
> This is a warning

> [!Note]
> This is a note

> [!Important]
> This is **important**

> [!TIP]
> Only if the service was good

> [!CAUTION]
> Be careful..

### Aesthetic text (aka scientific notation)

$This\ is\ nice\$
$e=mc^2$

### Footnotes

This has a footnote [^1] below

[^1]: The footnote

### Console Text

```console
$ grep foo bar
grep: bar: No such file or directory
[closing backticks omitted for formatting]

Footnotes

1. The footnote ↩