PyMdown 扩展
概述
PyMdown Extensions是Python Markdown的扩展集合。 最初编写它们是为了使编写文档更愉快。 它们涵盖了广泛的解决方案,虽然不是所有人都需要每个扩展,但通常至少有一个对每个人都有用的扩展。
使用
所有扩展都在pymdownx
的模块命名空间下找到。 假设我们想要指定MagicLink扩展的使用,我们将在Python Markdown中包含它,如下所示:
>>> import markdown
>>> text = "A link https://google.com"
>>> html = markdown.markdown(text, extensions=['pymdownx.magiclink'])
'<p>A link <a href="https://google.com">https://google.com</a></p>'
查看每个扩展的文档,以了解有关如何配置和使用每个扩展的更多信息。
Reminder
请阅读用法说明获取有关扩展兼容性的信息以及使用这些扩展时要注意的一般注意事项。
扩展
Arithmatex
Arithmatex是一个扩展,它在Markdown转换过程中保留LaTeX数学方程(\(\frac{\sqrt x}{y^3}\)),以便它们可以与MathJax一起使用。
B64 - Base64
B64将文档中的所有本地图像转换为base64编码并嵌入到文档中。
BetterEm
BetterEm是一种不同于Python Markdown默认的强调方法。 它的工作原理类似,但处理某些极端情况的方式不同。
Caret - 脱字符号
Caret是一个语法上围绕^
字符构建的扩展。 它增加了对插入 超级脚本 的支持,并添加了一种简单的方法来将 文本 放在html
标签。
Critic
Critic增加了对Critic Markup的处理和支持。
Emoji
Emoji 通过Markdown添加表情符号很容易 .
EscapeAll
EscapeAll 允许转义任何字符,其中一些具有附加效果。 点击这里了解更多。
Extra
Extra 就像Python Markdown的Extra包,除了它使用PyMdown扩展来替代类似的扩展。
Highlight
Highlight 允许您配置SuperFences 和 InlineHilite的语法高亮显示. 还通过语法高亮器传递标准Markdown缩进代码块。
InlineHilite
InlineHilite 突出显示内联代码: from module import function as func
.
Keys
Keys 使在文档中插入关键输入就像按 Ctrl+Alt+Del 键一样简单.
MagicLink
MagicLink 它可以链接URL和电子邮件链接,而不必用Markdown语法包装它们。 此外,它还为流行的代码托管提供商自动缩短了存储库发布、拉取请求和提交链接。 您甚至可以使用特殊的速记语法来链接问题、差异,甚至提到人
Mark
Mark 允许您轻松地 标记 单词。
PathConverter
PathConverter 将路径转换为给定基本路径的绝对路径或相对路径。
SaneHeaders
SaneHeaders 将哈希头修改为仅在开始哈希符号后面至少有一个空格时才计算。 如果您使用其他也使用哈希符号的扩展(如我们自己的MagicLink扩展),这是有用的。
SmartSymbols
SmartSymbols 通过简单的ASCII表示插入常用的Unicode字符: =/=
→ ≠.
Snippets
Snippets 将其他Markdown或HTML片段包含到当前正在解析的Markdown文件中。
StripHTML
StripHTML 可以去掉HTML注释和特定的标记属性。
SuperFences
SuperFences 就像Python Markdown的栅栏,但更好。 在列表、警告和其他语法下嵌套栅栏。 您甚至可以为UML之类的内容创建特殊的自定义栅栏。
graph TB
c1-->a2
subgraph one
a1-->a2
end
subgraph two
b1-->b2
end
subgraph three
c1-->c2
end
```diagram
graph TB
c1-->a2
subgraph one
a1-->a2
end
subgraph two
b1-->b2
end
subgraph three
c1-->c2
end
```
Tilde
Tilde 语法上是围绕~
字符构建的吗. 它增加了对插入子脚本的支持,并添加了一种简单的方法来将文本放入<del>
标签。