让 MkDocs 文档导航不再失控：awesome-nav 的分组、排序与隐藏方案

让 MkDocs 文档导航不再失控awesome-nav 的分组、排序与隐藏方案【免费下载链接】mkdocs-awesome-pages-pluginA plugin for customizing the navigation structure of your MkDocs site.项目地址: https://gitcode.com/gh_mirrors/mk/mkdocs-awesome-pages-pluginMkDocs 原生要求你在mkdocs.yml里手写整棵导航树页面一多就难以为继。awesome-nav原 mkdocs-awesome-pages-plugin是一款 MkDocs 插件按文件夹就近管理页面分组、排序与菜单标题适合文档层级开始变深的技术网站维护者。一、MkDocs 文档导航为什么难维护原生导航集中在单一配置文件里每加一个目录就要重排一遍。层级变多后nav越写越长页面顺序和分组调整全靠手工。菜单标题也受文件名和目录名限制想换个说法就得改名。二、页面分组和排序能解决什么问题插件在目录里放一个.nav.yml就能调整该目录下的导航行为子目录继承上级设置、局部再覆盖手动排序与规则排序可逐项指定顺序也可按名称等条件批量排序方向可翻转不必逐条拖动。自定义菜单标题菜单显示“API Endpoints”这类自定义名称文件名保持不变。隐藏页面与整段目录隐藏后页面不进入导航仍可通过 URL 访问也支持 glob 模式批量忽略。新建章节与外部链接导航里可以插入纯分组节点和站外链接不依赖真实文件。三、适合哪些 MkDocs 项目如果文档按模块分了多个目录它能把维护工作从全局配置拆回各目录本地。如果是教程型站点排序和章节标题可以按阅读路径组织而不是按文件名。如果文档混有 API 参考、内部草稿等不想出现在导航里的页面隐藏和忽略模式能减少手工剔除。四、如何判断是否值得用情况判断页面多、层级深nav已长到难读适合菜单标题需要与文件名、目录名解耦适合整站只有三五页且结构固定收益有限原生配置足够五、如何用最小配置开始使用安装插件pip install mkdocs-awesome-nav并在mkdocs.yml的plugins中注册awesome-nav。结构简单的站点可以先不改文件默认按文件夹组织即可。在需要调整的子目录放.nav.yml例如设置标题并隐藏草稿title: API Endpoints ignore: *.draft.md需要 clone 仓库时可使用git clone https://link.gitcode.com/i/cb5006101a09aa3b381029696307d39b。它把导航结构从集中管理变成就近管理导航维护成本能跟着文档规模走。【免费下载链接】mkdocs-awesome-pages-pluginA plugin for customizing the navigation structure of your MkDocs site.项目地址: https://gitcode.com/gh_mirrors/mk/mkdocs-awesome-pages-plugin创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考