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

Uploaded Source

Built Distribution

mkdocs_same_dir-0.1.1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs-same-dir-0.1.1.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.7 Linux/5.14.9-arch2-1

File hashes

Hashes for mkdocs-same-dir-0.1.1.tar.gz
Algorithm Hash digest
SHA256 94dee225a1b1363d82072ae0d499ee25d307b29f21b00944c220c1c1e39e1b45
MD5 261679c29ecf8537fda37d61f1918188
BLAKE2b-256 6086d8a9a9147f34143a752667e192cfac9aa4f2e5b7f2ca0bbe5f2fac7a3a65

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mkdocs_same_dir-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.7 Linux/5.14.9-arch2-1

File hashes

Hashes for mkdocs_same_dir-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0c24ef5a12bdf48d67100f8b9a67c4ebbea608896e4ea51731cebf60045e3b7b
MD5 917d16c01fdf5ae8174befbd5d49f147
BLAKE2b-256 f46162b613545eae863ff83ec15453c0356deaa6cb50286f2909e3ee4d5f47bc

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