Skip to main content

MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation

Project description

mkdocs-same-dir

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

PyPI License GitHub Workflow Status

pip install mkdocs-same-dir

Usage

Activate the plugin in mkdocs.yml, along with actually changing docs_dir
(normally, MkDocs 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 mkdocs.yml into your docs directory, or move your docs alongside mkdocs.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 MkDocs' internals. But I pledge to keep up with MkDocs updates and keep it working as long as that's still possible.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_same_dir-0.1.3.tar.gz (4.1 kB view hashes)

Uploaded source

Built Distribution

mkdocs_same_dir-0.1.3-py3-none-any.whl (4.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page