Important

Documentation writing should comply with MarkdownLint standards. Please refer to MarkdownLint Rules. You can use the VSCode Plugin to assist in writing.

Block Quote

The following introduces the 5 types of Block Quotes used in GitHub:

Note

Highlights information that users should take into account, even when skimming.

Tips

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.

However, note that nested Block Quotes will not be rendered by GitHub. For example:

1. First-level Block Quote
2. Second-level Block Quote

   Note

   Nested Block Quotes will not be rendered by GitHub.

Images

To add images to the documentation, follow these steps:

1. Upload the image to the public repository's Issues or Pull Requests.
   Example
2. Select Edit to see content like ![name](anonymized URL) and copy it for later use.
3. Use the ![name](anonymized URL) syntax to insert the image into the documentation.

Note

Images, GIFs, and videos uploaded by non-organization members should be smaller than 10MB.
More details