如何用MkDocs创建层级式个人讲义笔记目录结构
解决MkDocs层级讲义目录的配置问题
我懂你想要的是三级嵌套的讲义导航结构:顶层Index 1带概述、二级Index 1.1带概述、三级Index 1.1.1放完整章节内容。你当前的pages配置问题在于没有用嵌套结构,所有条目都处于同一层级,自然出不来预期的层级导航效果。
正确的MkDocs配置写法
MkDocs的pages支持通过嵌套列表构建层级导航,父级条目可以同时关联自己的概述文件和子级条目。下面是修改后的完整配置:
site_name: Lectures theme: readthedocs extra_javascript: - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML markdown_extensions: - mdx_math pages: - 'Index 1': - 'Index 1 概述': 'lec1/index.md' - 'Index 1.1': - 'Index 1.1 概述': 'lec1/week1/index.md' - 'Index 1.1.1': 'lec1/week1/sec1.md'
配置细节说明
层级对应逻辑:
Index 1作为一级导航,下挂自己的概述页面Index 1 概述(对应文件lec1/index.md)和二级导航Index 1.1Index 1.1作为二级导航,下挂自己的概述页面Index 1.1 概述(对应文件lec1/week1/index.md)和三级章节Index 1.1.1(对应内容文件lec1/week1/sec1.md)
本地文件结构要求:
你需要确保本地文件路径和配置完全匹配,示例结构如下:docs/ ├── lec1/ │ ├── index.md # Index 1的概述内容 │ └── week1/ │ ├── index.md # Index 1.1的概述内容 │ └── sec1.md # Index 1.1.1的章节内容 └── mkdocs.yml最终导航效果:
配置生效后,侧边栏会显示可折叠的层级结构:- Index 1
- Index 1 概述
- Index 1.1
- Index 1.1 概述
- Index 1.1.1
- Index 1
这样就完全实现了你想要的“父级展示概述、子级承载完整内容”的需求。
内容的提问来源于stack exchange,提问作者MrYouMath
相关产品推荐
相关产品推荐

