Skip to main content

mkdocs-same-dir

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

PyPI License GitHub Workflow Status

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.

Release files for mkdocs-same-dir 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-same-dir 0.1.5
File Size Uploaded
mkdocs_same_dir-0.1.5.tar.gz 5.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-same-dir 0.1.5
File Interpreter ABI Platform
mkdocs_same_dir-0.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 9.5 kB

Release files / mkdocs_same_dir-0.1.5.tar.gz

Download URL mkdocs_same_dir-0.1.5.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
677cf8d682d0ae6226620871c01906a1a631083f2b00fac58ffe9019b2cb2322
BLAKE2b-256 checksum
How to use checksums
2e58f49fdf5fd82cb82ab1ee4fb9a5729d741d8dd6bb9623e0471ad704a6f0c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 17, 2026.

Transparency log

Release files / mkdocs_same_dir-0.1.5-py3-none-any.whl

Download URL mkdocs_same_dir-0.1.5-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a9cc599caf438da288ba14b21d24db4bb7975106eef1cd56d0d92e6835c366aa
BLAKE2b-256 checksum
How to use checksums
caf0bc3618e170db0f47baf02f15ca465ee342a28400c5630e561fad9d1ff191
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 17, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page