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

使用 MkDocs 具有 Snippets extension 代码段和/或离线处理要求文件在本地可用,这在Pro Git书中有解释 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():
通过

.