2019-10-29_MkdocsのMaterialThemaで日本語検索ができない

このページで分かること

  • MaterialThemaをpip以外でインストールする方法
  • 日本語検索ができないときの復旧方法
  • カスタムテーマの適用方法

fedoraでこのBlogの更新用の環境構築をして、いざビルドしたら日本語検索が動作しなかったので対応方法を調べました。

結論としては、githubから最新のテーマファイルをダウンロードしてカスタムテーマとして適用すれば、無事に日本語検索が使用できるようになります。

環境

  • OS: fedora30
  • ミドル:
    • Python 3.6.0
    • pip 9.0.1
    • mkdocs 1.0.4

対応方法

差新板をgithubからclone

1
2
3
4
5
6
##c githubから最新のテーマをcloneする
##c ※なお、mkdocsのプロジェクトディレクトリ直下でcloneするとmkdocs.ymlなどが上書きされてしまうので注意。
##c 必要なファイルはmaterialディレクトリだけなので、tmpディレクトリあたりでcloneしてコピーすればOK
#r  REPO_URL='https://github.com/squidfunk/mkdocs-material.git'
#r  git clone ${REPO_URL}
#r  cp -pr mkdocs-material/material ${mkdocs-project-dir}

カスタムテーマの設定を反映

mkdocs.ymlに以下の内容を書き込みます。

※ 既にテーマの設定が入っている場合は適宜書き換えてください。

yamlフォーマットなのでスペースの数に注意してください。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
theme:
  name: null
  custom_dir: 'mkdocs-material/material'
  language: 'ja'
  palette:
    primary: 'indigo'
    accent: 'indigo'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'
  logo:
    icon: 'cloud'
  feature:
    tabs: true

動作確認の実施

サーバを立ち上げるかビルドコマンドを実施しエラーがなくサーバ起動 or ビルドが実施出来れば対応完了です。

1
2
3
4
#r  cd ${mkdocs-project-dir}
#r  mkdocs build
##c または
#r  mkdocs serve