如何在GitHub Gist中制作样式化的Markdown警示框?

my-*_*ord 16 markdown github-flavored-markdown

我正在尝试为Markdown制作一个Markdown提醒框,例如便笺框,警告框。我在Google上进行了一些搜索,发现有Python markdown的警告,但这些警告似乎在GitHub Gist上不起作用。

我已经尝试过遵循Python警告告诫,但是此markdown语法在GitHub Gist上不起作用。

!!! Hello Admonition
Run Code Online (Sandbox Code Playgroud)

我也尝试过这样的引导框,但是它没有预期的样式:

<div class="alert alert-danger" role="alert">
    <div class="row vertical-align">
        <div class="col-xs-1 text-center">
            <i class="fa fa-exclamation-triangle fa-2x"></i>
        </div>
        <div class="col-xs-11">
                <strong>Error:</strong>                   
        </div>   
    </div> 
</div>
Run Code Online (Sandbox Code Playgroud)

GitHub Gist是否有任何警告语法或HTML代码方法?

Von*_*onC 137

2024:Alerts markdown 语法的当前说明:sinsukehlab/NOTE-test/NOTE.md

警报

从:

## Simple alerts
> [!NOTE]
> This is a note.

> [!TIP]
> This is a tip. (Supported since 14 Nov 2023)

> [!IMPORTANT]
> Crutial information comes here.

> [!CAUTION]
> Negative potential consequences of an action. (Supported since 14 Nov 2023)

> [!WARNING]
> Critical content comes here.
Run Code Online (Sandbox Code Playgroud)

[十二月。2023]:

新的 Markdown 扩展:警报为重要内容提供独特的样式(2023 年 12 月)

https://i0.wp.com/github-product-user-asset-6210df.s3.amazonaws.com/2180038/290547405-0505deff-ff73-44f4-9f47-1d39b2f1d8cd.png?ssl=1 -- 的屏幕截图五种可用的 Markdown 警报类型

警报是一个 Markdown 扩展,以独特的颜色和图标显示,以指示内容的重要性。
支持五种不同类型的警报:

  • 注意:用户即使在浏览内容时也应该了解的有用信息。
  • 提示:有助于更好或更轻松地做事的有用建议。
  • 重要提示:用户需要了解实现其目标的关键信息。
  • 警告:紧急信息,需要用户立即注意以避免出现问题。
  • 注意:针对某些行为的风险或负面结果提供建议。

详细了解如何在文档中的 Markdown 内容中使用它们。


2023 年 7 月

根据您的反馈,我们进行了多项改进:

  • 输出现在将呈现为 div 而不是块引用。
  • 文本颜色已从之前的静音版本更改为主要颜色。
  • 我们收紧了解析规则,以防止与允许列表中的其他 Markdown 或 HTML 发生冲突。
    因此,现在需要在标题后面添加一个换行符。
  • 我们引入了一种新的警报类型IMPORTANT
  • 添加了一种新语法[!NOTE],它将逐渐取代旧语法。但是,旧语法将继续使用一段时间。

注意:在 Markdown 文件中,可以使用两个空格、反斜杠或 html
来实现硬换行[!NOTE] [!NOTE]\[!NOTE]<br>

所有三种类型的示例(后面有两个空格] ):

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.
Run Code Online (Sandbox Code Playgroud)

它们的显示方式如下:

强调


2022年5月,原答案:

虽然不完全是警告,但正如Diego Haz 所报告并在讨论 16925中所述,自 2022 年 5 月以来,这已得到支持(测试版测试)

为了更好地突出显示 GitHub 文档中的某些信息并将其与其他信息分开,我们现在在 Markdown 文档中呈现特殊且易于访问的注释或警告块引用。

我们使用块引用和粗体文本的现有语法。

第一行必须完全如下所示。
第一个字母区分大小写。第二行可以包含您的内容。

这个输入:

> **Note**
> This is a note

> **Warning**
> This is a warning
Run Code Online (Sandbox Code Playgroud)

变成:

注意/这是一个注意和警告/这是一个警告

警告:语法可能仍在演变,并且在讨论中存在争议。例如,Brenton M. Wiernik 评论道

除了其他人提出的语法问题和语义网络问题之外,我还担心这会在 GitHub-Flavored Markdown 和 pandoc markdown 或 CommonMark 之间引入主要的不兼容性。

大量 R 开发人员在 RMarkdown 中编写 README 和其他文档,一般使用 pandoc 进行处理。

此更改意味着当用户的包文档显示在 GitHub 上而不是其他地方时,用户将无法使用相同的语法获得一致的渲染。

以这种方式重载块引用会在不同 Markdown 风格的语法含义上产生不透明的差异,这对于开发人员来说很难编写。


对于 VSCodeIan Sanders提出:

这里有一些 VSCode 片段,以便更容易记住

> **Note**
> This is a note

> **Warning**
> This is a warning
Run Code Online (Sandbox Code Playgroud)

  • @Ramtin如果它遵循降价约定,则在警告后添加两个尾随空格应该启用 br. (4认同)

Jos*_*osh 25

您可以使用table创建一个带有一些粗体文本的框,如下所示:

| WARNING: be careful to baz the quux before initializing the retro encabulator! |
| --- |
Run Code Online (Sandbox Code Playgroud)

呈现如下:

单单元格表的图像,其中包含文本“警告:初始化复古encabulator之前请注意避免quux!”。

有点滥用语法,但是可以。克里斯指出,不幸的是没有办法应用其他格式,例如颜色。


Swi*_*vel 18

我经常使用的大多数存储库都使用blockquote来模拟一个警告:

> **WARNING**: Be careful, or else!
Run Code Online (Sandbox Code Playgroud)

下面是在顶部以及内部使用该示例的示例:

在此处输入图片说明


Tia*_*des 16

使用表情符号引起用户注意

> :warning: **If you are using mobile browser**: Be very careful here!
Run Code Online (Sandbox Code Playgroud)

Github示例

以下是其他表情符号列表(只需复制粘贴):

https://gist.github.com/roachhd/1f029bd4b50b8a524f3c

或者,您也可以使用GitHub markdown:

https://gist.github.com/rxaviers/7360908

  • FWIW,要获取 Unicode 警告标志的黄色/表情符号版本,请在其后面添加“variation selector-16”字符(例如,通过 HTML 实体引用:`⚠️`)。 (5认同)
  • 您可以简单地使用`:warning:`,而不是查找、复制和粘贴表情符号本身所需的繁琐工作 (5认同)
  • @shamaseen 这仅适用于 GitHub Markdown、iirc。如果您使用的是不支持 GH 表情符号的其他 Markdown 处理器,它可能无法工作。 (5认同)
  • @Swivel 谢谢你的建议,我已经改变了我的答案以使用 github markdown。 (2认同)
  • 不要这样做。`&gt;` 用于块引号。“blockquote 元素表示从其他来源引用的部分。” 根据 W3C。由于您没有引用任何内容,因此这是*错误的*元素。如果您需要警告,AsciiDoc 和 reStructured Text 都支持警告。CommonMark 中还有一个用于警告的开放 RFC。 (2认同)
  • ⚠️这里是要复制的 unicode 字符,如果 `:warning:` 不适合您:) (2认同)

小智 14

在使用 UTF8 符号的标准降价中,这看起来很不错:

> **? WARNING: Aliens are coming.**  
> A description of the colour, smell and dangerous behaviour of the aliens.
Run Code Online (Sandbox Code Playgroud)

哪个渲染是这样的:

? 警告:外星人来了。
对外星人的颜色、气味和危险行为的描述。


Chr*_*ris 7

GitHub Flavored Markdown 没有类似的东西,它的HTML,无论是生成的还是内联的,都经过了积极的清理

您可能不得不使用基础知识,例如

_**Warning:** Be very careful here._
Run Code Online (Sandbox Code Playgroud)

或者

### Warning

Be very careful here
Run Code Online (Sandbox Code Playgroud)


小智 6

最简单的方法:

| This project was moved and hosted on Render. |
|----------------------------------------------|
Run Code Online (Sandbox Code Playgroud)

将导致:

该项目已转移并托管在 Render 上。


Xam*_*rix 6

您可以使用表格或引号(仅在 Gitlab 和 Github 上测试):

\n

使用表

\n
| \xe2\x9a\xa0\xef\xb8\x8f Warning                               | \n|------------------------------------------|\n| You shouldn\'t. This is irreversible!     |\n\n| \xe2\x9d\x8c Error                                 | \n|------------------------------------------|\n| Don\'t do that. This is irreversible!     |\n\n| \xe2\x84\xb9\xef\xb8\x8f Information                           | \n|------------------------------------------|\n| You can do that without problem.         |\n\n| \xe2\x9c\x85 Success                               | \n|------------------------------------------|\n| Don\'t hesitate to do that.               |\n\n|  New line support                       | \n|-------------------------------------------|\n| It supports new lines:<br/>.. simply use `<br/>` for new lines|\n
Run Code Online (Sandbox Code Playgroud)\n

使用桌子的可憎行为

\n

使用报价

\n
\n> **\xe2\x9a\xa0\xef\xb8\x8f Warning**\n>\n> You shouldn\'t. This is irreversible!\n\n> **\xe2\x9d\x8c Error**\n>\n> Don\'t do that. This is irreversible!\n\n> **\xe2\x84\xb9\xef\xb8\x8f Information**\n>\n> You can do that without problem.\n\n> **\xe2\x9c\x85 Success**\n>\n> Don\'t hesitate to do that.\n\n> ** New line support**\n> \n> It supports new lines:\n>\n> .. simply use an empty `>` line\n>\n
Run Code Online (Sandbox Code Playgroud)\n

使用引号的可憎行为

\n