arthurgousset/markdown

✨ markdown cheat sheet

Markdown (Cheat Sheet)

Tip

This is a cheat sheet for all things markdown (mostly notes-to-self). They are incomplete by default

Style guides

Technical writing style guides:

• Google style guide
• Apple style guide
• Red Hat supplementary style guide for product documentation

Non-technical style guides:

• The Chicago Manual of Style (subscription required).
• The Associated Press Stylebook (subscription required).

Github admonitions

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.

> [!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.

Source: [Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta) #16925