mkdocs-same-dir 0.1.5

ProperDocs plugin to allow placing properdocs.yml in the same directory as documentation

mkdocs-same-dir

Plugin for ProperDocs to allow placing properdocs.yml in the same directory as documentation

pip install mkdocs-same-dir

Usage

Activate the plugin in properdocs.yml, along with actually changing docs_dir
(normally, ProperDocs absolutely wouldn't let you set it to .):

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

plugins:
  - search
  - same-dir

and now you can move this properdocs.yml into your docs directory, or move your docs alongside properdocs.yml.

See example layout

Important notes

Another necessary effect of this plugin is that files directly at the root of the docs dir will no longer be picked up, unless they are Markdown files.

And note that the implementation of this plugin is a huge hack that monkeypatches ProperDocs' internals. But I pledge to keep up with ProperDocs updates and keep it working as long as that's still possible.