Mkdocs Literate Nav

Overview

The mkdocs-literate-nav plugin offers a unique way to manage navigation for your MkDocs site, leveraging Markdown rather than the usual YAML format. This innovative approach allows users to create structured navigation files that provide greater flexibility and easier customization. With this plugin, you can specify your site's navigation through a simple Markdown syntax, enhancing the overall usability and readability of your documentation.

Not only does this plugin improve the organization of your navigation, but it also aligns perfectly with other MkDocs extensions, making it a valuable addition for any documentation project. By eliminating the reliance on YAML and empowering users with Markdown, the mkdocs-literate-nav plugin streamlines the workflow significantly.

Features

• Markdown Navigation Specification: Define your site's navigation using Markdown syntax instead of cumbersome YAML, making it easier to read and write.

• Local Directory Navigation: Each directory can have a separate navigation list allowing for better organization per section of your documentation.

• Cross-Linking Support: Create links to directories using a straightforward syntax, promoting a cohesive navigation experience across different pages.

• Flexible Page Ordering: Specify the order of pages explicitly or let files be inferred automatically, giving you control over the navigation structure.

• Wildcard Support: Use wildcards in your navigation definitions, enabling you to define patterns for file inclusion without needing to specify each file individually.

• Integration with Other Plugins: Works seamlessly with section-index and gen-files plugins, enhancing functionality while simplifying management.

• Fallback Behavior: If no navigation is specified, the plugin defaults to MkDocs’ original behavior, allowing for gradual adoption of the new system.