文本格式化: Formatting

在MkDocs中实现更加丰富的文笔渲染效果

配置项

下面对文本显示的高级效果提供支持

markdown_extensions:
  - pymdownx.critic
  - pymdownx.mark
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.keys

示例

基本划线与高亮

依赖插件: pymdownx.caret，pymdownx.mark，pymdownx.tilde

基本的划线高亮有如下三种样式

• 高亮: 这是一行高亮的文本
• 下划线: 这是一行下划线的文本
• 删除线: 这是一行删除线的文本

源码:

高级高亮样式

依赖插件: pymdownx.critic，pymdownx.mark

下面是几种不同的文本内容的高亮效果:

• 普通高亮效果: 这是一段普通高亮的文本
• 注释高亮效果: 这是一段注释高亮的文本
• 删除高亮效果: 这是一段删除高亮的文本
• 下划线高亮效果: 这是一段下划线高亮的文本
• 删除和下划线一起使用效果: 弃用旧的使用新的

源码:

下面是段落高亮效果的示例(其它高亮样式同理):

君不见黄河之水天上来，奔流到海不复还； 君不见高堂明镜悲白发，朝如青丝暮成雪。

长太息以掩涕兮，哀民生之多艰。 余虽好修姱以鞿羁兮，謇朝谇而夕替。 既替余以蕙纕兮，又申之以揽茝。 亦余心之所善兮，虽九死其犹未悔。

风萧萧兮易水寒，壮士一去兮不复还。

源码:

上下标

依赖插件: pymdownx.critic，pymdownx.tilde

上标：x^2^y
下标：H~2~O

• 上标：x²y
• 下标：H₂O

键盘按键

依赖插件: pymdownx.keys

++ctrl+alt+del++

效果: Ctrl+Alt+Del

更多的键盘按键对应的代码参考: Keys - PyMdown Extensions Documentation

参考

• Formatting - Material for MkDocs
• Keys - PyMdown Extensions Documentation