コンテンツにスキップ

MKDocs Document Config

Tip

  • ドキュメントの構成はmkdocs.ymlのnavに指定します。
  • navを設定すると画面左側に表示されるドキュメントの一覧が表示されます。
  • 以下のnav設定をベースにするとドキュメントの追加、変更に適した構成で管理がしやすいと思います。
mkdocs.yaml
1
2
3
4
5
6
7
8
9
nav: 
  - Home: index.md 
  - Programming language:
      - ja/programming-language/index.md 
      - Python:
      - ja/programming-language/python/index.md 
          - Mkdocs tips:
              - ja/programming-language/python/mkdocs/index.md 
              - ja/programming-language/python/mkdocs/display-config_tips.md

Tip

複数のドキュメントを持つ構成の場合は以下の設定で十分です。

mkdocs.yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
theme:
  features:
    # Enable link setting on section
    - navigation.indexes
    # Back-to-top button
    - navigation.top
    # groups in the sidebar
    #- navigation.sections
    # expand all collapsible subsections
    #- navigation.expand