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 ответ

Решение

Ваш pages конфиг недействителен.

Во-первых, раздел должен заканчиваться двоеточием (:), чтобы указать, что следующие отступы - это дочерние элементы раздела.

- Lecture:
  - 'week 1'...

Во-вторых, только "раздел" может иметь детей. "Страница" не может иметь детей.

- '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'
Другие вопросы по тегам