MkDocs

• Configuration - MkDocs
• Getting started - Material for MkDocs
• Deploying Your Docs - MkDocs
• プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ | DevelopersIO

GitHub Pages設定

手動実行してGitHub Pages公開

ソースmarkdown用リポジトリは既に存在し、リモートリポジトリに設定されている状態で

$ mkdocs gh-deploy --clean
INFO    -  Cleaning site directory 
INFO    -  Building documentation to directory: /home/zaki/src/github-pages/site 
INFO    -  Documentation built in 0.19 seconds 
WARNING -  Version check skipped: No version specified in previous deployment. 
INFO    -  Copying '/home/zaki/src/github-pages/site' to 'gh-pages' branch and pushing to GitHub. 
INFO    -  Your documentation should shortly be available at: https://zaki-lknr.github.io/pages/ 

リモートリポジトリにgh-pagesブランチが作成され、ここにビルドされたコンテンツがpushされて以下のURLにコンテンツが公開された。
ディレクトリ名はリポジトリ名になっている。

https://zaki-lknr.github.io/pages/

GitHub Actions連携

MkDocs で作ったドキュメントを GitHub Actions を使って GitHub Pages にデプロイしよう | ultra code

• 以下を用意
  • ソースmarkdown用リポジトリ
    • リポジトリ名は任意
  • GitHub Pages公開コンテンツ用リポジトリ
    • このリポジトリ名は<GitHubユーザー名>.github.ioにする

GitHub Pagesはドキュメントルートで公開

公開用リポジトリ名を.github.ioにすればOKだった。
詳細は未確認。

Github pagesで意地でもサブディレクトリをルートにする | Matsuura Tomoya|松浦知也

コンテンツ設定

色設定

• Changing the colors - Material for MkDocs
• MKDocs – 基本のドキュメント配色設定方法 | DevelopersIO

コードハイライト

MKDocs – 拡張プラグイン集(1) | DevelopersIO

あとで公式もチェックするか。。

この辺かな:
Code blocks - Material for MkDocs

日本語検索

materialテーマの場合

Material for MkDocs を日本語対応した話＆初めてのOSSコントリビュート - miyalog

Google Analytics設定

Setting up site analytics - Material for MkDocs

google_analytics:
  - UA-XXXXXXXX-X
  - auto

取り消し線の有効化

Material for MkDocsを使っていると(?)、~~による取り消し線が動作しない。
以下設定を追加すると有効になる。

markdown_extensions:
    - pymdownx.tilde