special-usage-of-markdown.md

In addition to the common usage of markdown, there are also some special usage of markdown.

Mention

• In github, you can use #id tp mention the specific PR or issue in the repository.
• @username is also available which can mention the specific account of developer.

Emoji

You can add the :emoji-code: in the markdown to appear the corresponding icon. You can check the whole codes here. Use regularly:

• 🎉
• ⭐
• 👍

Fontnote

You can add the footnotes through [^id or name].

Alerts

The markdown support this five infomation signs: [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION].

These are shown as follows:

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

Anchors

If you want to refer to the title or subtitle, you can use the anchors. But there still lay the conditions:

1. convert the title into all lower-case.
2. Whitespaces are replaced by hyphens(-), any other punctuations are removed.
3. If there are the same sentences, then auto-increment integer, as [some texts](#sentence) and [some texts](#sentence-1)

Color modes

Only support in issue, PR and discuss.

• HEX: #RRGGBB #0969DA
• RGB: rgb(R,G,B) rgb(9, 105, 218)
• HSL: hsl(H,S,L) hsl(212, 92%, 45%)

Basic line style

• *italic*: italic
• ~~strikethrough~~: strikethrough
• <sub>subscript</sub>: _subscript
• <sup>superscript</sup>: ^superscript
• <ins>underline</ins>: underline