mkdocsの基本設定

mkdocsをインストールしていない場合は、mkdocsのインストールを参照してください。

mkdocsの設定

mkdocs.yml

site_name: My Docs

theme:
  name: material
  palette:
    - scheme: default
      primary: green
      accent: light green
      toggle:
        icon:  material/toggle-switch-off-outline
        name: ダークモードに切り替えます。
    - scheme: slate
      primary: 'teal'
      accent: 'orange'
      toggle:
        icon: material/toggle-switch
        name: ライトモードに切り替えます。
  features:
    - search.suggest         ## 検索の候補リスト表示を表示する
    - search.highlight       ## 検索で一致した結果をハイライトする
  font:
    text: Roboto
    code: Roboto Mono
  language: ja


markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

ディレクトリ構成

mkdocsのディレクトリ構成は以下のようになります。
プロジェクトのルートディレクトリにdocsディレクトリを作成し、その中にマークダウンファイルを配置します。

my-project/
├── docs/
│   ├── index.md
│   ├── wsl.md
│   └── Git/
│       └── gitインストール.md
└── mkdocs.yml

コメント