首页 > 解决方案 > 如何使 mkdocs 在多个位置支持 Markdown 文档?

问题描述

MkDocs 是一个很棒的基于 Markdown 语言的文档工具。但是,目前它仅支持本文档显示的一个特定位置的文档(请参阅mkdocs 配置):

docs_dir 包含文档源 markdown >files 的目录。这可以是相对目录,在这种情况下,它是相对于包含配置文件的目录进行解析的,也可以是来自本地文件系统根目录的绝对目录路径。

默认值:“文档”

但是,在我的情况下,我的 Markdown 文件位于多个位置,并且它们不共享相同的父目录。关于如何让 mkdocs 搜索多个文档文件夹的任何想法?

标签: markdownmkdocspython-markdown

解决方案


如果您在 linux 上工作,您可以轻松地创建一个通用docs文件夹并使用软链接ln -s /real/path/for/part1 docs/part1将它们组合在一起。现在 mkdocs 将像所有内容都在同一个父目录中一样工作。

在 Windows 上,使用mklink.


推荐阅读