Project description

mkdocs-same-dir

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

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

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

0.1.3

Jan 31, 2024

This version

0.1.2

Sep 28, 2022

0.1.1

Oct 6, 2021

0.1.0

Oct 16, 2020

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.2.tar.gz (3.4 kB view details)

Uploaded Sep 28, 2022 Source

Built Distribution

mkdocs_same_dir-0.1.2-py3-none-any.whl (3.7 kB view details)

Uploaded Sep 28, 2022 Python 3

File details

Details for the file mkdocs-same-dir-0.1.2.tar.gz.

File metadata

Download URL: mkdocs-same-dir-0.1.2.tar.gz
Upload date: Sep 28, 2022
Size: 3.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.5 CPython/3.10.7

File hashes

Hashes for mkdocs-same-dir-0.1.2.tar.gz
Algorithm	Hash digest
SHA256	`dfb0d8e8b4930a8c7fc3f8ad558d647e8243cd4e1b6e6178e5fa8c1423b0ee45`
MD5	`bd124c76bedaa6bb9d9647b98d593e70`
BLAKE2b-256	`dcfcd942b429df5a5617554ca3159415dd07c5b2dae3f94f7ca6120d9914e38f`

See more details on using hashes here.

Provenance

File details

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

File metadata

Download URL: mkdocs_same_dir-0.1.2-py3-none-any.whl
Upload date: Sep 28, 2022
Size: 3.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.5 CPython/3.10.7

File hashes

Hashes for mkdocs_same_dir-0.1.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`627991894d51a9fcc54e7d3f0c48a2be3c0a248e015bbeb8e90d4f95f1ac59ba`
MD5	`2d61811878e1d09b085d62acf1a56f66`
BLAKE2b-256	`df83cd954eb7e5a670a7c4e3c04496f1865e9458ef4ff22beb162a2cdb20d2d6`