在 MkDocs 代码块中显示应用程序源代码文件

Question

如何在 MkDocs 中显示现有的源代码文件？我想直接将来自另一个 GitHub 存储库的文件包含在代码块中而不重新格式化它们，以便更新的文件将显示在 MkDocs 文档中。

sample_code.py

    def fn():
        pass

Answer 1

使用 MkDocs with Snippets extension. Snippets and/or off-line processing require files to be available locally which is explained in the Pro Git book Git Tools Submodules section.

1. 包括完整的文件路径，即使文件在同一文件夹中也是如此：

index.md

.
```python
--8<-- "docs/sample_code.py"
```
.

2. 创建源代码文件：

sample_code.py

def fn():
    pass

3. 将扩展添加到 mkdocs 配置文件：

mkdocs.yml

site_name: Demo

markdown_extensions:
    - pymdownx.snippets:

nav:
    - Demo: index.md

---

输出

.

def fn():
    pass

.