{"id":21579,"library":"mkdocs-same-dir","title":"mkdocs-same-dir","description":"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.","status":"active","version":"0.1.5","language":"python","source_language":"en","source_url":"https://github.com/oprypin/mkdocs-same-dir","tags":["mkdocs","plugin","properdocs","documentation"],"install":[{"cmd":"pip install mkdocs-same-dir","lang":"bash","label":"Default install"}],"dependencies":[{"reason":"Core dependency; this is a MkDocs plugin.","package":"mkdocs","optional":false}],"imports":[{"note":"Plugin class must be imported from the module, not just the package.","wrong":"import mkdocs_same_dir","symbol":"same_dir","correct":"from mkdocs_same_dir import same_dir"}],"quickstart":{"code":"# mkdocs.yml\nplugins:\n  - same_dir\n","lang":"yaml","description":"Enable the plugin in your mkdocs.yml configuration."},"warnings":[{"fix":"Install and use 'properdocs' instead of 'mkdocs'.","message":"Plugin warns when used with the original 'mkdocs' executable. It is intended for use with the 'properdocs' executable as part of the ProperDocs project.","severity":"deprecated","affected_versions":">=0.1.4"},{"fix":"Place mkdocs.yml in the docs directory and verify paths in the configuration are relative to that directory.","message":"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.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Install with 'pip install mkdocs-same-dir' and ensure the plugin is listed as '- same_dir' (not 'mkdocs-same-dir').","cause":"The plugin is not installed or the import path is incorrect in mkdocs.yml.","error":"Plugin 'same_dir' not found"},{"fix":"Install ProperDocs and use 'properdocs serve' instead of 'mkdocs serve'.","cause":"Using the original MkDocs executable with this plugin.","error":"ValueError: The 'same_dir' plugin is not intended to be used with the 'mkdocs' executable. Please use 'properdocs'."}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}