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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file mkdocs_same_dir-0.1.3.tar.gz.

File metadata

  • Download URL: mkdocs_same_dir-0.1.3.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for mkdocs_same_dir-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c849556b1d79ae270947f41bb89d442aa1e858ab6ec6423eb178ae76a7f984fc
MD5 c2d1914505807d472758a3fdda1afdb3
BLAKE2b-256 fca76a82cc2d73339f46ec4752e60b8bd5e412f104a2da9c8ad60c537c0e2cf5

See more details on using hashes here.

Provenance

File details

Details for the file mkdocs_same_dir-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_same_dir-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3d094649e2e47efcf90a8b0051a4c2b837aaf4137a28c8e334ba9465804a317e
MD5 26be89277595de859c01172da7a2ff0d
BLAKE2b-256 2e3e8fe1e052756db178aec15cbcc30d60b5e10bf131078c9f785498379743e9

See more details on using hashes here.

Provenance

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