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

Question

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

sample_code.py

    def fn():
        pass

Answer 1

将MkDocs与Snippets extension一起使用。摘要和/或离线处理要求文件在本地可用，这在Pro Git书Git Tools Submodules section中进行了说明。

1. 即使文件位于同一文件夹中，也要包含完整的文件路径：

index.md

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

1. 创建源代码文件：

sample_code.py

def fn():
    pass

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

mkdocs.yml

site_name: Demo

markdown_extensions:
    - pymdownx.snippets:

nav:
    - Demo: index.md

---

输出

。

def fn():
    pass

。