Mkdocs消除了文件中的复制粘贴

时间:2016-03-10 14:17:55

标签: markdown readme mkdocs

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

2 个答案:

答案 0 :(得分:1)

将一个文档包含在另一个文档中不是Markdown功能,目前MkDocs仅对Markdown文档进行Markdown处理。因此,目前没有办法用MkDocs做到这一点。

有趣的是,似乎没有人提出过这样的功能请求。有一个待处理的功能可以使各种变量显示在Markdown页面中(参见问题#304),但没有提及包括其他文档。也就是说,根据所选择的解决方案,如果/何时解决问题,它还可以提供包含其他页面的能力。

无论哪种方式,如果/当添加插件API时(请参阅问题#206),您应该可以对自己进行任何预先处理,包括通过支持“包含”的模板系统运行Markdown文本解析Markdown之前的页面。事实上,我希望如果您要提出功能请求,答案就是将其插入插件。

答案 1 :(得分:0)

@doktoric是正确的:要弄清记录, MkDocs中有一个解决方案,其中包括使用外部文件,其中涉及使用markdown-include extension

语法如下:

{!filename.md!}

实现此目的的过程是:

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

mkdocs.yml文件中:

    markdown_extensions:
        include