Mkdocs Awesome Nav

screenshot of Mkdocs Awesome Nav
mkdocs

A plugin for customizing the navigation structure of your MkDocs site.

Overview

Awesome Nav for MkDocs, previously known as the mkdocs-awesome-pages-plugin, is an intuitive and powerful tool that enhances the navigation capabilities of your MkDocs projects. This plugin enables users to have precise control over their documentation's navigation structure, making it easy to add links, reorder items, and customize the layout without the hassle of coding everything from scratch.

Whether you're looking to simply add external links or overhaul the entire navigation tree, Awesome Nav provides all the features you need for seamless document management. Its robustness makes it a must-have for anyone who wants to improve their MkDocs experience.

Features

  • Adjusting Item Order: Easily reorder navigation items manually or take advantage of extensive sorting options to display them in your desired arrangement.
  • Adding Sections & Links: Create distinct sections in your navigation and add external links to enhance accessibility and user experience.
  • Customizing Titles: Modify the titles of sections and override existing page titles for improved clarity and organization.
  • Hiding Pages: Keep certain pages or even entire sections hidden from navigation, allowing them to be accessible only through direct URLs.
  • Using Glob Patterns: Utilize glob patterns to match files and control visibility, enabling further customization of what is displayed based on your preferences.

With these features, Awesome Nav transforms how you manage navigation in your MkDocs documentation, making it more flexible and user-friendly.

mkdocs
MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.