📄 Markdown

Danger

Most of these entries are only compatible with GFM.
View on GitHub

Blockquote highlight¶

[!NOTE]
Highlights information that users should take into account, even when skimming.

[!TIP] Optional information to help a user be more successful.

[!IMPORTANT]
Crucial information necessary for users to succeed.

[!WARNING]
Critical content demanding immediate user attention due to potential risks.

[!CAUTION] Negative potential consequences of an action.

The initial syntax used on GitHub was:

Single line

Note This is a single line note

Warning This is a single line warning

Multiline

Note
This is a multiline note

Warning
This is a multiline warning

🔗

Color models¶

In issues, pull requests, and discussions, you can call out colors within a sentence by using backticks.

Color	Syntax	Example	Output
HEX	`#RRGGBB`	`#0055A4`	`#0055A4`
RGB	`rgb(R,G,B)`	`rgb(255, 255, 255)`	`rgb(255, 255, 255)`
HSL	`hsl(H,S,L)`	`hsl(4, 85%, 57%)`	`hsl(4, 85%, 57%)`

🔗

Details summary¶

Toggle with the open attribute in the <details> tag.

Details

<details open>
    <summary>Details</summary>
    Something small enough to escape casual notice.
</details>

Diff¶

- Hello, World!
+ Hello, Simon!

Footnotes¶

View on GitHub

Here is a simple footnote[^1].

[^1]: My reference.

🔗

GeoJSON¶

View on GitHub

Specs & Viewer

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "properties": {
                "label": "Paris"
            },
            "geometry": {
                "type": "Point",
                "coordinates": [
                    2.3522,
                    48.8566
                ]
            }
        },
        {
            "type": "Feature",
            "properties": {
                "label": "France"
            },
            "geometry": {
                "type": "Polygon",
                "coordinates": [
                    [
                        [
                            -5.225,
                            41.333
                        ],
                        [
                            9.55,
                            41.333
                        ],
                        [
                            9.55,
                            41.333
                        ],
                        [
                            9.55,
                            51.2
                        ],
                        [
                            -5.225,
                            51.2
                        ],
                        [
                            -5.225,
                            41.333
                        ]
                    ]
                ]
            }
        }
    ]
}

GitHub Custom Emojis¶

View on GitHub

:atom:
:basecamp: :basecamp:
:basecampy: :basecampy:
:bowtie: :bowtie:
:electron: :electron:
:feelsgood: :feelsgood:
:finnadie: :finnadie:
:goberserk: :goberserk:
:godmode: :godmode:
:hurtrealbad: :hurtrealbad:
:neckbeard: :neckbeard:
:octocat: :octocat:
:rage1: :rage1:
:rage2: :rage2:
:rage3: :rage3:
:rage4: :rage4:
:shipit: :shipit:
:suspect: :suspect:
:trollface: :trollface:

🔗

Image with reference link¶

[![alt text][image]][hyperlink]

[hyperlink]: https://…
[image]: https://… "tooltip"

Keyboard¶

Ctrl + Alt + Suppr

Maths¶

View on GitHub

This sentence uses $ delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$

The Cauchy-Schwarz Inequality

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)

🔗

Mermaid¶

graph LR
    A[Square Rect] -- Link text --> B((Circle))
    A --> C(Round Rect)
    B --> D{Rhombus}
    C --> D

Mermaid info¶

info

Prefers color scheme¶

Shows an illustrated sun in light color mode and a moon with stars in dark color mode.

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/25423296/163456776-7f95b81a-f1ed-45f7-b7ab-8fa810d529fa.png">
  <img alt="Shows an illustrated sun in light color mode and a moon with stars in dark color mode." src="https://user-images.githubusercontent.com/25423296/163456779-a8556205-d0a5-45e2-ac17-42d089e3c3f8.png">
</picture>

🔗

Reference labels¶

View on GitHub

https://github.com/SimonMarquis/TIL/labels/bug • https://github.com/SimonMarquis/TIL/labels/enhancement • https://github.com/SimonMarquis/TIL/labels/good%20first%20issue • https://github.com/SimonMarquis/TIL/labels/help%20wanted • https://github.com/SimonMarquis/TIL/labels/invalid • https://github.com/SimonMarquis/TIL/labels/question • https://github.com/SimonMarquis/TIL/labels/wontfix

🔗

Table alignment¶

Left	Center	Right
⬤	⬤	⬤

| Left | Center | Right |
|:-----|:------:|------:|
| ⬤ | ⬤ | ⬤ |

Theme context for images¶

View on GitHub

GitHub-Mark-Light GitHub-Mark-Dark

![GitHub-Mark-Light](https://user-images.githubusercontent.com/3369400/139447912-e0f43f33-6d9f-45f8-be46-2df5bbc91289.png#gh-dark-mode-only)![GitHub-Mark-Dark](https://user-images.githubusercontent.com/3369400/139448065-39a229ba-4b06-434b-bc67-616e2ed80c8f.png#gh-light-mode-only)

🔗