mkdocs-same-dir

0.1.5 verified Mon Apr 27 auth: no python

A MkDocs plugin that allows placing the mkdocs.yml configuration file in the same directory as your documentation source files, rather than in a parent directory. Version 0.1.5, maintained as part of the ProperDocs ecosystem. Release cadence is low.

pip install mkdocs-same-dir

Common errors

error Plugin 'same_dir' not found ↓

cause The plugin is not installed or the import path is incorrect in mkdocs.yml.

fix

Install with 'pip install mkdocs-same-dir' and ensure the plugin is listed as '- same_dir' (not 'mkdocs-same-dir').

error ValueError: The 'same_dir' plugin is not intended to be used with the 'mkdocs' executable. Please use 'properdocs'. ↓

cause Using the original MkDocs executable with this plugin.

fix

Install ProperDocs and use 'properdocs serve' instead of 'mkdocs serve'.

Warnings

deprecated Plugin warns when used with the original 'mkdocs' executable. It is intended for use with the 'properdocs' executable as part of the ProperDocs project. ↓

fix Install and use 'properdocs' instead of 'mkdocs'.

gotcha The plugin only affects how mkdocs.yml is resolved; it does not change the behavior of MkDocs itself. Ensure your configuration follows standard MkDocs conventions. ↓

fix Place mkdocs.yml in the docs directory and verify paths in the configuration are relative to that directory.

Imports

same_dir
wrong
```
import mkdocs_same_dir
```
correct
```
from mkdocs_same_dir import same_dir
```
Plugin class must be imported from the module, not just the package.

Quickstart

Enable the plugin in your mkdocs.yml configuration.

# mkdocs.yml
plugins:
  - same_dir