mkpatcher

mkpatcher 是一个 Python-Markdown 扩展，允许任意脚本修改 MkDocs 输入文件。

目录

• 安装
• 使用方法
  • 原始脚本
  • 文件系统上的脚本
• 许可证

安装

1. pip install mkpatcher

2. 将扩展包含在您的 mkdocs.yml 配置文件中

   ...
   markdown_extensions:
     ...
     - mkpatcher:
         ...
   

使用方法

此扩展作为预处理器使用，并允许在运行其他扩展之前修改 Markdown 的原始行。

原始脚本

script 选项接受任意 Python 代码，并将 Markdown 行作为名为 lines 的变量提供。

您可以直接修改这些行

...
markdown_extensions:
  ...
  - mkpatcher:
      script: |
        lines.extend(('', 'some footer', ''))

或者您可以遮蔽这个变量

...
markdown_extensions:
  ...
  - mkpatcher:
      script: |
        lines = ['entirely', 'new']
        lines.append('markdown')

文件系统上的脚本

location 选项接受指向单个 Python 文件或包含多个 Python 文件的目录的路径。如果位置引用的是目录，则脚本将按字典顺序加载并最终执行，基于文件名。

...
markdown_extensions:
  ...
  - mkpatcher:
      location: docs/.scripts

每个脚本必须定义一个名为 patch 的可调用对象，该对象接受一个参数，该参数将是 Markdown 行。

您可以直接修改这些行

def patch(lines):
    lines.extend(('', 'some footer', ''))

或者您也可以返回新行

def patch(lines):
    new_lines = ['entirely', 'new']
    new_lines.append('markdown')
    return new_lines

许可证

mkpatcher 根据 Apache 许可证，版本 2.0 和 MIT 许可证的条款进行分发

• Apache 许可证，版本 2.0
• MIT 许可证

您自行选择。