markdown - Mkdocs 消除文件中的复制粘贴

Question

我能否以某种方式将文件包含到 mkdocs 中的文件中？我不想一次又一次地复制粘贴相同的部分。谢谢

Answer 1

@doktoric 是正确的:澄清一下，MkDocs 中有一个包含外部文件的解决方案，它涉及使用 markdown-include extension .

语法如下:

{!filename.md!}

实现的过程是:

1. 根据说明安装扩展(pip install markdown-include)
2. 修改mkdocs.yml 文件，为您的网站注册此扩展sees explanations , 及以下。
3. 开始在 markdown 文件中使用语法扩展。

在mkdocs.yml文件中:

    markdown_extensions:
        include

---

更新(2020 年 9 月)

现阶段我建议的解决方案是通过 mkdocs-macros plugin (我写的)。该插件实现了一个 jinja2 模板引擎，这意味着 the {% include ... %} statement is available out of the box :

## Paragraph
{% include 'snippet.md' %}

只需安装插件，在 mkdocs.yml 中声明它，就可以了。