Skip to main content

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

Project description

Awesome Nav for MkDocs

Formerly known as mkdocs-awesome-pages-plugin. Read more about the change

This MkDocs plugin gives you full control over your navigation structure without having to write the entire thing by hand. Whether you just want to add an external link or restructure the entire navigation tree, awesome-nav has you covered.

Feature Highlights

  • Adjusting Item Order: Manually re-order navigation items or use the extensive sorting options.
  • Adding Sections & Links: Create sections and add external links.
  • Customizing Titles: Change the title of sections and override page titles.
  • Hiding Pages: Hide pages or entire sections from the navigation, making them only accessible by url.
  • Using Glob Patterns: Match files using glob patterns to show or hide them.

Check out the documentation for more information and examples.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_awesome_nav-3.1.0.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_awesome_nav-3.1.0-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_awesome_nav-3.1.0.tar.gz.

File metadata

  • Download URL: mkdocs_awesome_nav-3.1.0.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.0

File hashes

Hashes for mkdocs_awesome_nav-3.1.0.tar.gz
Algorithm Hash digest
SHA256 4dbcdc17d36683fb9e384ba9a07094aecaddee1a7155ec38c4231f62feb3d03f
MD5 5b3e63edc2f73f13472f0ce813578ed7
BLAKE2b-256 2f79f9907fc5f1c62ea0661d5b35a74510adffce7a1d9ad2d36183f9f7a175ba

See more details on using hashes here.

File details

Details for the file mkdocs_awesome_nav-3.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_awesome_nav-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e82b90754611b62018860c7d49b431ab80ca42037136a904441ade9b63b05541
MD5 c19fc22ae24bfdbc31c6746a37472e4a
BLAKE2b-256 9112132b4aa5bf0cb312310c8ef4fba4e6b4c60289a876d74b7fd9089bff1918

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page