mkdocs：如何创建类似结构的文件夹

Question

我想用我的个人讲义创建一个小的本地文件。我想要的结构是

索引 1（包含子文件夹的概述，但不包含它们的全部内容）索引 1.1（包含子文件夹的概述，但不包含它们的全部内容）索引 1.1.1（包含部分内容）

目前我的mkdocs.yml看起来像

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:
- Lecture1 
  - 'week 1': 'lec1/week1.md'
      - 'section 1': 'lec1/week1/sec1.md

但是前面的代码并没有像我想要的那样显示。

Answer 1

您的 pages 配置无效。

首先，一个部分必须以冒号 (:) 结尾，以表明后面的缩进行是该部分的 children。

- Lecture:
  - 'week 1'...

其次，只有"section"才能有children。 "page" 不能有 children。

- 'week 1':
  - Summary: 'lec1/week1.md'
  - 'section 1': 'lec1/week1/sec1.md'

是的，这意味着您需要为 week1.md 页面添加一个额外的条目。我给它起的标题是Summary。当然，您可以使用您认为更合适的任何名称。无论如何，完整的配置应该是这样的：

pages:
  - Lecture:
    - 'week 1':
      - Summary: 'lec1/week1.md'
      - 'section 1': 'lec1/week1/sec1.md'

mkdocs：如何创建类似结构的文件夹

mkdocs: How to create Folder like structure

directory

web

mkdocs