# Awesome Nav for MkDocs
> Formerly known as `mkdocs-awesome-pages-plugin`. [Read more about the change](https://lukasgeiter.github.io/mkdocs-awesome-nav/migration-v3)
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](https://lukasgeiter.github.io/mkdocs-awesome-nav) for more information and examples.
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-awesome-nav",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "mkdocs, markdown, documentation, navigation",
"author": null,
"author_email": "Lukas Geiter <info@lukasgeiter.com>",
"download_url": "https://files.pythonhosted.org/packages/43/73/f50a8c1d069be63db7083435c8074bcd0d8cf55dcfe033e95c883a7f1598/mkdocs_awesome_nav-3.0.0.tar.gz",
"platform": null,
"description": "# Awesome Nav for MkDocs\n\n> Formerly known as `mkdocs-awesome-pages-plugin`. [Read more about the change](https://lukasgeiter.github.io/mkdocs-awesome-nav/migration-v3)\n\nThis 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.\n\n### Feature Highlights\n\n- **Adjusting Item Order**: Manually re-order navigation items or use the extensive sorting options.\n- **Adding Sections & Links:** Create sections and add external links.\n- **Customizing Titles**: Change the title of sections and override page titles.\n- **Hiding Pages**: Hide pages or entire sections from the navigation, making them only accessible by url.\n- **Using Glob Patterns**: Match files using glob patterns to show or hide them. \n\n---\n\n[Check out the documentation](https://lukasgeiter.github.io/mkdocs-awesome-nav) for more information and examples.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A plugin for customizing the navigation structure of your MkDocs site.",
"version": "3.0.0",
"project_urls": {
"source": "https://github.com/lukasgeiter/mkdocs-awesome-nav/"
},
"split_keywords": [
"mkdocs",
" markdown",
" documentation",
" navigation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c1c96995b9c503c5b434c829bb991056e176551539a29420645d7e726c5c5047",
"md5": "8834a104e3ab130af406c2f10c9e25a3",
"sha256": "eda804face3aeb641d9eb1d7e5b024532e201235af9bbe21fccee0147a3b257d"
},
"downloads": -1,
"filename": "mkdocs_awesome_nav-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8834a104e3ab130af406c2f10c9e25a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 11370,
"upload_time": "2025-02-16T17:29:42",
"upload_time_iso_8601": "2025-02-16T17:29:42.582362Z",
"url": "https://files.pythonhosted.org/packages/c1/c9/6995b9c503c5b434c829bb991056e176551539a29420645d7e726c5c5047/mkdocs_awesome_nav-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4373f50a8c1d069be63db7083435c8074bcd0d8cf55dcfe033e95c883a7f1598",
"md5": "b8cd21a00e613b3af93648711625c11a",
"sha256": "17023bd8067728cc7bff880bb4843dc97018108fd8d8e0d62f938bb0b6156569"
},
"downloads": -1,
"filename": "mkdocs_awesome_nav-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b8cd21a00e613b3af93648711625c11a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7862,
"upload_time": "2025-02-16T17:29:43",
"upload_time_iso_8601": "2025-02-16T17:29:43.712739Z",
"url": "https://files.pythonhosted.org/packages/43/73/f50a8c1d069be63db7083435c8074bcd0d8cf55dcfe033e95c883a7f1598/mkdocs_awesome_nav-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-16 17:29:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lukasgeiter",
"github_project": "mkdocs-awesome-nav",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-awesome-nav"
}
JSON
