2023年7月:
我们根据您的反馈进行了几项改进:
- 输出现在将呈现为一个 div 而不是一个 blockquote。
- 文本颜色已从之前的柔和版本更改为主要颜色。
- 我们已经加强了解析规则,以防止与其他 Markdown 或 HTML 冲突。
因此,标题后面现在需要一个换行符。
- 我们引入了一个新的警告类型 "IMPORTANT"。
- 添加了一种新的语法 "[!NOTE]",逐渐取代旧的语法。然而,旧的语法将继续使用一段时间。
注意:
在 Markdown 文件中,可以通过两个空格 "[!NOTE] ",反斜杠 "[!NOTE]\" 或 html "
" 来实现硬换行。
以下是三种类型的示例(在 "] " 后面有两个空格):
> [!NOTE]
> 强调用户在浏览时应该考虑的信息。
> [!IMPORTANT]
> 用户成功所必需的关键信息。
> [!WARNING]
> 由于潜在风险,需要立即引起用户注意的关键内容。
以下是它们的显示方式:
2022年5月,原始答案:
虽然不完全是一种警告,但自2022年5月以来,这一点得到了支持(进行了测试),正如Diego Haz所报道的,并在讨论16925中描述的那样。
To better highlight and separate certain information from the rest in your documentation on GitHub, we now render a special and accessible note or warning blockquote in Markdown documents.
We are using the existing syntax for blockquote and bold text.
The first line must be exactly as shown below.
The first letter is case sensitive. The second line can contain your content.
This input:
> **Note**
> This is a note
> **Warning**
> This is a warning
Becomes:
![Note / This is a note and Warning / This is a warning](https://istack.dev59.com/FiB6U.webp)
警告:语法可能仍在演变中,并在讨论中进行辩论。例如,
Brenton M. Wiernik comments:
除了其他人提出的语法问题和语义网问题之外,我还担心这会在GitHub-Flavored Markdown和pandoc markdown或CommonMark之间引入重大的不兼容性。
许多R开发人员使用RMarkdown编写README和其他文档,通常使用pandoc进行处理。
这个改变意味着当用户的软件包文档在GitHub上显示和其他地方显示时,无法以相同的语法获得一致的渲染。
以这种方式重载引用块会在不同的markdown风格中创建一个意义上的不透明差异,对开发人员来说很难解决。
使用 VSCode, Ian Sanders 提出了以下建议:
这里有一些 VSCode 代码片段,可以帮助你更容易地记住它们
{
"Note": {
"prefix": "note",
"body": [
"> [!NOTE]",
"> $1"
],
"description": "GFM Note block"
},
"Important": {
"prefix": "important",
"body": [
"> [!IMPORTANT]",
"> $1"
],
"description": "GFM Important block"
},
"Warning": {
"prefix": "warning",
"body": [
"> [!WARNING]",
"> $1"
],
"description": "GFM Warning block"
}
}