Skip to content

Mkdocsのカスタマイズ方法

Override

overridesフォルダを作成し、main.htmlを作成。

{% extends "base.html" %}
{% block libs %}
  <!-- ここにheadタグのスクリプト -->
   <!-- Google Seach Consoleタグ -->
  <meta name="google-site-verification" content="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" />
  {{ super() }}
{% endblock %}
{% block scripts %}
  {{ super() }}
  <!-- ここにbody閉じタグ直前のスクリプト -->
{% endblock %}

次に、mkdocs.ymlcustom_dir: overridesを追加します。

theme:
  name: "material"
  custom_dir: overrides

トラッキングコードの埋め込み

Material for Mkdocsのテーマでは、Google Tag Manager/Google Analyticsがデフォルトでサポートされている。 mkdocs.ymlに下記の記述を追加することでheadタグ内に計測コードを設置できる。

extra:
  analytics:
    provider: google
    property: G-XXXXXXXXXX
G-XXXXXXXXXXにGTMのコードを入力する。

参考

Material for MkdocsにCustomizationを使ってサイト分析ツールを導入してみた