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

时间:2018-01-09 09:31:39

标签: web directory mkdocs

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

索引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

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

1 个答案:

答案 0 :(得分:1)

您的pages配置无效。

首先,一个部分必须以冒号(:)结尾,以表示后面的缩进行是该部分的子句。

- Lecture:
  - 'week 1'...

其次,只有"部分"可以生孩子A"页面"不能生孩子。

- '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'