Mkdocs Same Dir

Overview

The mkdocs-same-dir plugin is a handy tool for MkDocs users who prefer to streamline their project directory. This plugin allows developers to place the mkdocs.yml configuration file in the same directory as their documentation files, breaking away from the traditional structure mandated by MkDocs. This flexibility can enhance organization within projects, making it easier for teams to manage their documentation alongside the configuration files.

Incorporating this plugin can significantly improve workflow efficiency. By simply activating it in the mkdocs.yml, users gain the ability to customize their directory structure according to their unique project needs. However, users should be aware that this solution is a workaround that modifies MkDocs' core functionality, and caution is advised regarding potential future compatibility.

Features

• Flexible Configuration Location: Place mkdocs.yml alongside the documentation files in the same directory for easier management.
• Custom Directory Structure: Move documentation files alongside the configuration without restructuring the entire project layout.
• Markdown File Handling: Files in the root of the docs directory will be ignored unless they are Markdown files, optimizing content organization.
• Commitment to Updates: The developer promises to maintain compatibility with future MkDocs updates, despite the plugin's unconventional methods.
• Enhanced Workflow: Streamline the documentation process, reducing clutter and extending project flexibility.
• Open Source License: Developed under the PyPI license, ensuring it's freely available for community use and contribution.
• Github Workflow Integration: Easily integrates into existing GitHub workflows, making it suitable for collaborative development environments.