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

Question

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

示例代码.py

    def fn():
        pass

标签： version-controlmkdocs

Answer 1

将MkDocs与Snippets 扩展一起使用。片段和/或离线处理需要文件在本地可用，这在 Pro Git 书籍Git 工具子模块部分中进行了说明。

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

索引.md

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

2. 创建源代码文件：

示例代码.py

def fn():
    pass

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

mkdocs.yml

site_name: Demo

markdown_extensions:
    - pymdownx.snippets:

nav:
    - Demo: index.md

---

输出

.

def fn():
    pass

.