重要

文档编写应符合 MarkdownLint 规范，请参考 MarkdownLint 规则，可通过VSCode插件辅助编写。

Block Quote

接下来介绍 Github 5种 Block Quote 的用法：

注

Highlights information that users should take into account, even when skimming.
突出显示用户应考虑的信息，即使在浏览时也是如此。

提示

Optional information to help a user be more successful.
帮助用户取得更大成功的可选信息。

重要

Crucial information necessary for users to succeed.
用户成功所需的重要信息。

注意

Critical content demanding immediate user attention due to potential risks.
由于存在潜在风险，需要用户立即关注的关键内容。

警告

Negative potential consequences of an action.
操作的潜在负面后果。

不过需要注意，嵌套的 Block Quote 不会被 github 渲染。像下面这样：

1. 第一层 Block Quote
2. 第二层 Block Quote

   注

   嵌套的 Block Quote 不会被 github 渲染。

图片

为了向文档中添加图片，我们采取以下步骤：

1. 上传图片到公共仓库的 Issues 或 Pull Requests 中
   样例
2. 选择 Edit 看到类似 ![name](anonymized URL) 的内容，复制待用
3. 在文档中使用 ![name](anonymized URL) 语法插入图片

注

非组织成员上传的图片、GIF、视频应小于10MB
更多详细信息