コンテンツにスキップ

Document Config Tips

Tip

  • ドキュメントの構成はmkdocs.ymlのnavに指定します。
  • navを設定すると画面左側に表示されるドキュメントの一覧が表示されます。
  • 以下のnav設定をベースにするとドキュメントの追加、変更に適した構成で管理がしやすいと思います。
mkdocs.yaml
1
2
3
4
5
6
7
8
9
nav: # (1)!
  - Home: index.md # (2)!
  - Programming language:
      - ja/programming-language/index.md # (3)!
      - Python:
      - ja/programming-language/python/index.md # (4)!
          - Mkdocs tips:
              - ja/programming-language/python/mkdocs/index.md # (5)!
              - ja/programming-language/python/mkdocs/display-config_tips.md # (6)!
  1. - navigation.indexesを有効にするとindex.mdをリンク先として設定する
  2. 初期画面
  3. Programming languageセクションの初期ページ
  4. Pythonセクションの初期ページ
  5. ・Mkdocs tipsの初期ページ
    ・Page1: ja/programming-language/python/mkdocs/index.mdという表記も可能
    ・明示的に表示しない場合は"h1"タグの内容が表示される
  6. サブセクション、または、index.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

コメント