跳转到主要内容

Markdown扩展:更优雅的admonitions语法

项目描述

markdown-callouts

Python-Markdown扩展:admonitions的更优雅语法

PyPI GitHub GitHub Workflow Status

安装

pip install markdown-callouts

如果使用MkDocs,请在 mkdocs.yml中启用扩展

markdown_extensions:
  - callouts

继续访问文档站点

用法

这为Markdown添加了一个新的块级语法,可以将一段文本放入一个特别突出且与文本其他部分分开的块中。

示例

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.

结果,使用mkdocs-material

Screenshot

可折叠的块也有相应的语法

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

这会显示为一个初始时关闭的<details>块。

优雅降级

此扩展生成与admonition扩展相同的结果,但语法更加不侵入,并为“纯”渲染器提供了非常合理的回退外观。

例如,比较如果我们实际上编写了上面的Markdown并将其输入GitHub的Markdown解析器,您会看到什么。

“标注”语法

注意: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.

“警告”语法

!!! 注意

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.

继续访问文档站点

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

markdown_callouts-0.4.0.tar.gz (9.8 kB 查看哈希)

上传时间

构建分布

markdown_callouts-0.4.0-py3-none-any.whl (7.1 kB 查看哈希)

上传时间 Python 3

支持者