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.3.0.tar.gz (9.1 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.3.0-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocs_awesome_nav-3.3.0.tar.gz
Algorithm Hash digest
SHA256 330edf4129995a7be8a9751edd8739d312fddf591c6cbd95ec80f12f4bfe8578
MD5 f74dc1ff29e447574a03cb06d0eb4e5d
BLAKE2b-256 1f96d581c9ceae7d8c08c7456d1d2befbf3e9c7a52a6b03aebbe6dc1d46ffdac

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_awesome_nav-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bf80f14bff9571df79129bbdf103b4198589ee7616f8a29720ae2e7ac2455930
MD5 26a4e2292b7c84e91c64757f2c177f36
BLAKE2b-256 de98dc154a7f0bb25827d988dc31992917606d1ca9f5349077db045bb5cd9dbc

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