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.1.tar.gz (8.7 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.1-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocs_awesome_nav-3.1.1.tar.gz
Algorithm Hash digest
SHA256 0665ab290a3c22b49e07151e3aca82d5d28a42aecf6e940bf295546565d156b5
MD5 82dbd1089f96440b78e00434f9216dd0
BLAKE2b-256 2de0b2185370a35ecc042f648beec27a6d1a5d15d2ad46255d68201d2ba9cc38

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_awesome_nav-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 50eafd8042274feff2b995ecaa50c55c07807ff33210a064877f6f1aa8d6ee40
MD5 9a88e738ad0b2227395c7b307bfa4f39
BLAKE2b-256 0b0384bdfc698c5307259b269c5c20b8d62c7f2f36667f0a10d4d311dc604546

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