PyMdown扩展

用法

PyMdown扩展是Python Markdown扩展的集合。 请记住,PyMdown扩展的设计是为了与默认扩展配合使用,所以当与其他第三方扩展配对时,您的里程可能会有所不同。

所有的扩展名都在pymdownx下面。 假设我们想要指定MagicLink扩展的使用,我们会像Python一样将它包含在Python Markdown中:

>>> import markdown
>>> text = "A link https://google.com"
>>> html = markdown.markdown(text, ['pymdownx.magiclink'])
'<p>A link <a href="https://google.com">https://google.com</a></p>'

查看每个扩展的文档,了解更多关于如何配置和使用每个扩展。

提醒

请阅读使用说明以获取有关扩展兼容性的信息,以及使用这些扩展时需要注意的一般注意事项。

扩展

Arithmatex

Arithmatex是在Markdown转换过程中保留LaTeX数学方程(\frac{\sqrt x}{y^3}) 的一个扩展,因此它们可以与MathJax一起使用。

B64

B64 将文档中的所有本地图像转换为base64编码并将其嵌入到文档中.

BetterEm

BetterEm 是与Python Markdown的默认不同的重点方法。 它的工作方式类似,但处理某些角落的情况不同

Caret

Caret 是在^字符周围构建的扩展. 它增加了对插入超级脚本的支持 并添加一个简单的方法将文本放置在<ins>标记中。

Critic

Critic 增加了对批评标记的处理和支持.

Details

Details<details><summary>标签创建可折叠的元素.

点击我!

谢谢

Emoji

Emoji 通过Markdown轻松添加表情符号 😄.

EscapeAll

EscapeAll 允许逃离任何角色, 一些有额外的效果. 检查了解更多.

Extra

Extra 就像Python Markdown的额外软件包一样,除了使用PyMdown扩展来代替类似的扩展.

ExtraRawHTML

ExtraRawHTML 暴露了Python Markdown在HTML块中解析降价的功能. 当你想要做的就是在HTML块中解析Markdown的时候,你不再需要包含所有的Extra.

Highlight

Highlight 允许您配置SuperFences和InlineHilite的语法高亮显示. 还通过语法高亮显示器传递标准Markdown缩进代码块.

InlineHilite

InlineHilite highlights inline code: from module import function as func.

Keys

Keys 使按键输入到文档中就像按下一样简单 CtrlAltDel.

MagicLink

MagicLink 链接URL和电子邮件链接,而不必用Markdown语法包装它们. 此外,允许缩短资源库问题,拉取请求和提交链接。 你甚至可以使用轻松插入提及: @twitter.

Mark

Mark 可以让你轻松==标记==单词.

PathConverter

PathConverter 将路径转换为绝对或相对于给定的基本路径.

ProgressBar

ProgressBar 快速创建进度条

SmartSymbols

SmartSymbols 通过简单的ASCII表示插入常用的Unicode字符: =/= → ≠.

Snippets

Snippets 在正在解析的当前Markdown文件中包含其他Markdown或HTML片段.

StripHTML

StripHTML 可以去掉HTML注释和特定的标签属性.

SuperFences

SuperFences就像Python Markdown的栅栏,但更好。 在列表,告诫和其他语法下嵌套围栏。 还为UML等内容创建特殊的自定义栅栏。

Title: 这里是标题
A->B: 正常线
B-->C: 虚线
C->>D: 打开箭头
D-->>A: 虚线打开箭头

Tasklist

Tasklist 允许用复选框插入列表.

Tilde

Tilde Tilde是在~字符的语法上构建的。 它增加了对插入子脚本的支持,并增加了一个简单的方法将 text 放置在#!html <del>标签中。