MkDocs のテーマ mkdocs-docskimmer を導入してみた

Intro - docSkimmer theme

緑基調でスッキリしてて一目見て気に入ったので、導入してみることに。

前提

  • Windows 10
  • MkDocs 1.0.4
  • Python 3.7.4

インストール

テンプレートの入手

pip はまだ使えないので git clone で手動で取ってきて、mkdocs プロジェクトに配置する必要がある。

まずは docSkimmer のテンプレートファイルたちを配置する。

$ cd (mkdocs new したプロジェクトフォルダ)
$ git clone https://github.com/hfagerlund/mkdocs-docskimmer/
$ move mkdocs-docskimmer\mkdocs_docskimmer .\

紛らわしいが mkdocs-docskimmer\mkdocs_docskimmer を MkDocs プロジェクト直下に配置する。

mkdocs.yml の設定

ソースファイルは docs/index.md だけつくってるものとする。

site_name: お試し

nav:
  - Intro: index.md

theme:
  name: null
  custom_dir: 'mkdocs_docskimmer'
  include_search_page: true
  search_index_only: false
  static_templates:
  - 404.html

plugins: ['search']

extra:
    version: 0.4.0

こんな漢字。theme.name は null のままで良い。

これで設定完了。

ビルド

普通に mkdocs build する。

感想

まだまだ発展途上。

  • 検索結果から各ページにジャンプできない
  • TOC(ON THIS PAGE)をクリックすると TOC の表示が乱れる(with Firefox v69)

今後に期待 or 勉強がてら何か修正してプルリクってみるのもいいかも。