MkDocs Pygments

代码块高亮主题。

安装

此项目仅供赞助商通过我的Insiders计划使用。请参阅Insiders 说明 和 安装说明。

用法

在 mkdocs.yml 中进行配置

# mkdocs.yml
plugins:
- pygments:
    light: autumn
    dark: github-dark

要了解哪些主题可用，您可以选择阅读我们的文档，或者使用一个不存在的主题，以错误和列出可用主题的消息终止构建

# mkdocs.yml
plugins:
- pygments:
    light: wodjweofijwqefd
    dark: github-dark

$ mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
ERROR   -  pygments: Unknown theme: 'wodjweofijwqefd'. Available themes:
           abap, algol, algol_nu, arduino, autumn, bw, borland, coffee,
           colorful, default, dracula, emacs, friendly_grayscale, friendly,
           fruity, github-dark, gruvbox-dark, gruvbox-light, igor, inkpot,
           lightbulb, lilypond, lovelace, manni, material, monokai, murphy,
           native, nord-darker, nord, one-dark, paraiso-dark, paraiso-light,
           pastie, perldoc, rainbow_dash, rrt, sas, solarized-dark,
           solarized-light, staroffice, stata-dark, stata-light,
           tango, trac, vim, vs, xcode, zenburn

您可以指示MkDocs Pygments忽略由主题设置的背景色，以便它适用于浅色和深色方案。

例如，要使用 autumn 风格（这是一个浅色主题），同时适应背景色，以适用于浅色和深色方案

# mkdocs.yml
plugins:
- pygments:
    light: autumn
    respect_light_background: true  # default value
    dark: autumn
    respect_dark_background: false

要使用 github-dark 风格（这是一个深色主题），同时适应背景色，以适用于浅色和深色方案

# mkdocs.yml
plugins:
- pygments:
    light: github-dark
    respect_light_background: false
    dark: github-dark

默认情况下，会尊重背景颜色，因此您实际上不必指定 respect_<light/dark>_background: true。