Mkdocs_include_dir_to_nav

Overview

The mkdocs-include-dir-to-nav plugin revolutionizes how directories are displayed in your mkdocs navigation. By effectively expanding folders and automatically integrating all sub-files, this tool brings efficiency and ease to managing documentation websites. Its ability to make modifications during the build or serve process without altering the configuration file simplifies the user's experience, making it ideal for developers who want a streamlined setup.

This plugin caters to the needs of documentations that often expand in complexity. With a variety of customizable options, users can tailor the navigation structure with just a few configuration changes. Whether you’re working with a simple project or a more complex documentation site, this tool enhances the overall usability of mkdocs.

Features

• Recursive Scanning: Automatically scans through directories to replace them with their corresponding sub-files, ensuring a comprehensive navigation experience.
• Multiple File Types Supported: Accepts all classic mkdocs file types, including direct references and those with titles, making it versatile for different documentation styles.
• Custom Title Options: Allows the use of file names as section titles instead of relying on headings within the files, giving you more control over your navigation structure.
• Flexible Sorting: Options to sort files and directories in both ascending and descending order enhance organization and can be tailored to specific needs.
• Include Empty Directories: An option to include all subdirectories, even if they contain no valid documents, ensuring no part of the structure is overlooked.
• Advanced File Pattern Matching: Users can define regex patterns to filter which markdown files to include, adding another layer of customization.
• Toggling Nested Searches: Options to enable or disable nested directory scans help streamline the navigation based on project structure.
• Flat Directory Option: The ability to disable sub-folder sections keeps the navigation simple and focused, removing unnecessary layers for smaller projects.