mkdocs-same-dir

插件 for MkDocs to allow placing mkdocs.yml in the same directory as documentation

pip install mkdocs-same-dir

用法

在 mkdocs.yml 中激活插件，同时实际更改 docs_dir
(通常，MkDocs 绝对 不允许您将其设置为 .)

site_name: foo
docs_dir: .
site_dir: ../site

plugins:
  - search
  - same-dir

现在您可以将此 mkdocs.yml 移动到您的 docs 目录中，或将文档移到 mkdocs.yml 旁边。

查看示例布局

重要提示

此插件另一个必要的效果是，docs 目录根目录中的文件将不再被选中，除非它们是Markdown文件。

请注意，此插件的实现 是一个巨大的hack，它通过monkeypatches MkDocs的内部机制。但我承诺将跟进MkDocs的更新，并在可能的情况下保持其工作。