{"library":"mkdocs-awesome-nav","title":"MkDocs Awesome Nav Plugin","description":"A plugin for customizing the navigation structure of your MkDocs site. It enhances the standard MkDocs navigation with features like glob patterns, dynamic sorting, and conditional visibility, allowing for more flexible site organization. The current version is 3.3.0, and it follows a feature-driven release cadence with occasional major updates.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install mkdocs-awesome-nav"],"cli":null},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"# mkdocs.yml\nsite_name: My Awesome Docs\n\nplugins:\n  - awesome-nav\n\nnav:\n  - Home: index.md\n  - 'User Guide':\n      - guide/*.md # Example of a glob pattern\n  - 'API Reference': api/\n\n# To build the site:\n# mkdocs build\n# To serve the site locally:\n# mkdocs serve\n","lang":"yaml","description":"To use the mkdocs-awesome-nav plugin, you must first install it and then enable it in your `mkdocs.yml` configuration file under the `plugins` section. This example demonstrates a basic navigation setup including a glob pattern for automatic file inclusion.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}