如何在 GitHub Gist 中制作一个风格化的 Markdown 警告框?

我正在尝试制作一个 Markdown 警告框,比如笔记框,GitHub Gist 的警告框。我在 Google 上做了一些搜索,我找到了 Python 的减价忠告,但是这些忠告似乎不适用于 GitHub Gist。

我试过遵循 巨蟒警告,但是这种标记语法在 GitHub Gist 上不起作用。

!!! Hello Admonition

我也试过像这样的引导盒,但它没有预期的风格:

<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>

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

130351 次浏览

GitHub 风味降价没有任何类似的东西和它的 HTML,生成的或内联的,是积极地消毒

你可能不得不勉强应付一些基本的东西,例如。

_**Warning:** Be very careful here._

或者

### Warning


Be very careful here

你可以使用 桌子创建一个包含粗体文本的框,如下所示:

| WARNING: be careful to baz the quux before initializing the retro encabulator! |
| --- |

这是这样渲染的:

An image of a single-cell table, containing the text "WARNING: be careful to baz the quux before initializing the retro encabulator!"

虽然有点滥用语法,但是很管用。不幸的是,没有办法应用其他格式,如颜色,正如克里斯指出。

我参与过的大多数仓库都使用 lockquote 来模拟警告:

> **WARNING**: Be careful, or else!

下面是一个例子,它被用在顶部,以及内部,一个部分:

enter image description here

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

> :warning: **If you are using mobile browser**: Be very careful here!

Github example

下面是其他的表情包(只是复制粘贴) :

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

或者你也可以使用 GitHub 标记:

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

一个简单突出的警告可以这样实现:

>[!WARNING]
>This is a warning

看起来是这样的:

在使用 UTF8符号的标准标记中,这看起来相当不错:

> **⚠ WARNING: Aliens are coming.**
> A description of the colour, smell and dangerous behaviour of the aliens.

其渲染方式如下:

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

MkDocs 的材料提供了几种不同类型的警告,并允许包含和嵌套任意内容。

首先,你应该 配置:

markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences

然后,你可以在降价时使用 警告:

!!! note


Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

资料来源: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types

虽然不完全是一个警告,这是支持(测试版测试)自2022年5月以来,作为 由迭戈 · 哈兹报道讨论16925中描述

为了更好地突出显示 GitHub 文档中的某些信息,并将其与其他信息区分开来,我们现在在 Markdown 文档中呈现一个特殊的、可访问的说明或警告块引号。

我们正在使用现有的块报价语法和粗体文本。

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

这个输入:

> **Note**
> This is a note


> **Warning**
> This is a warning

成为:

Note / This is a note and Warning / This is a warning

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

除了其他人提出的语法问题和语义网问题,我还担心这会导致 GitHub-Flavored Markdown 和 pandoc Markdown 或 Common Mark 之间的主要不兼容性。

大量的 R 开发人员使用 RMarkdown 编写 README 和其他文档,通常使用 pandoc 进行处理。

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

以这种方式重载 block quote 会在不同的标记风格之间产生语法含义上的不透明差异,对于开发人员来说,这是非常难以解决的问题。