[!IMPORTANT] 文档编写应符合 MarkdownLint 规范,请参考 MarkdownLint 规则,可通过VSCode插件辅助编写。
接下来介绍 Github 5种 Block Quote 的用法:
[!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.
操作的潜在负面后果。
不过需要注意,嵌套的 Block Quote 不会被 github 渲染。像下面这样:
[!NOTE] 嵌套的 Block Quote 不会被 github 渲染。
为了向文档中添加图片,我们采取以下步骤:
Issues
或 Pull Requests
中Edit
看到类似 
的内容,复制待用
语法插入图片[!NOTE] 非组织成员上传的图片、GIF、视频应小于10MB
更多详细信息