Mkdocs Awesome Nav

Overview

The Awesome Pages Plugin for MkDocs is a powerful tool that enhances the way you organize and present documentation on your MkDocs site. With this plugin, you can easily customize the navigation structure without the need to delve deep into the mkdocs.yml configuration file. It allows for greater flexibility and control over how your pages are displayed, enabling a more user-friendly experience for your readers.

If you’ve been looking for a way to streamline your documentation layout while maintaining an organized structure, this plugin could be the solution you've been searching for. It’s designed to simplify the process, saving you time and effort so you can focus more on creating content rather than managing configurations.

Features

• Customize Navigation: Easily create a .pages file to define the navigation structure and the order of files and directories without cluttering the main configuration.

• Rest Filtering: Exclude pages or sections from the navigation and use glob patterns or regular expressions to fine-tune what appears based on file names.

• Custom Titles: Optionally assign a unique title for each navigation entry, offering clearer labels for your sections.

• Add Links: Enhance your navigation further by using the nav attribute to insert additional links as needed, improving connectivity across your documentation.

• Change Sort Order: Control the order of items in your navigation by simply setting the order attribute to either ascending or descending.

• Natural Sort Type: Implement a natural sort for your pages by using the sort_type attribute, making it easier for users to find what they’re looking for.

• Order By Preference: Adjust the arrangement of your items by filename or title with the order_by attribute, providing flexibility in how content is prioritized.

• Collapse Single Nested Pages: Optionally minimize visibility on single nested pages to keep your navigation clean and user-focused.