MkDocsで始める個人ブログ作成

静的サイトジェネレータのMkDocsを使って個人サイトを作成したときのメモです。

インストール

今回はパッケージ管理をryeで行いました。インストールしていない場合はbrew install ryeでインストールしておきます。

必要なライブラリをインストールします。

Bash
rye init
rye add mkdocs mkdocs-material
rye sync

ryeを使っているので、mkdocsのコマンドを利用する際にはrye runをつけて実行する必要があります。

mkdocs serveはポートが利用されていない場合、8000番ポートでサーバが立ち上がります。

Bash
rye run mkdocs new .
rye run mkdocs serve

Google Analytics 4のトラッキングを行うためには、mkdocs.ymlに以下のように記述します。

YAML
extra:
  analytics:
    provider: google
    property: G-XXXXXXXXX

GA4のトラッキングを有効化した状態でローカルで動かすと、トラッキング情報が送信されるため無効化する方法です。

やり方としてはこれでよいのか微妙ではあるが、トラッキングID関連の設定はActionsで追記する形にしました。

そのため、mkdocs.ymlの最後のプロパティはextraにしておく必要があります。

YAML
- name: Build MkDocs Site
  run: |
    echo -e "  analytics:\n    provider: google\n    property: G-XXXXXXXXX" >> mkdocs.yml
    mkdocs build