テーマしたい(theme)
theme:
name: mkdocs # or readthedocs
language: ja
mkdocs.yml の theme セクションでドキュメントサイトの外観を設定できます。
標準テーマしたい(mkdocs)
theme:
name: mkdocs
mkdocsはデフォルトのテーマ名です。
Bootstrapをベースにした設計で、MkDocsのほぼすべての機能をサポートしています。シンプルで軽量なテーマです。
Read The Docsしたい(readthedocs)
theme:
name: readthedocs
readthedocsはRead the Docsサイトのデフォルトテーマと同じデザインです。
サイドバーナビゲーションが特徴で、より限定的な機能セットです。
言語を設定したい
theme:
name: mkdocs
language: ja
language キーで表示言語を指定できます。
jaで日本語、enで英語、その他17以上の言語に対応しています。
パレットしたい
theme:
name: mkdocs
palette:
color_mode: light # light, dark, auto
user_color_mode_toggle: true
nav_style: primary # primary, dark, light
theme.paletteセクションで、サイト全体の色を設定できます。
設定できる項目はテーマによって異なります。
paletteの標準オプション:
color_mode: カラーモード(light、dark、auto)user_color_mode_toggle: ユーザーがカラーモードを切り替え可能にする(デフォルト: false)nav_style: ナビゲーションバーのスタイル(primary、dark、light)
features(機能)を有効にしたい
mkdocs テーマで利用可能な機能
theme:
name: mkdocs
features:
- code.highlight.js
- search.suggest
- search.share
標準で利用可能な機能:
code.highlight.js- highlight.jsによるソースコードのシンタックスハイライトsearch.suggest- 検索候補の表示search.share- 検索結果の共有機能nav.instant- ページ遷移時のプリロード(読み込み速度向上)toc.integrate- 目次をサイドバーに統合
ロゴを設定したい(theme.logo)
theme:
name: mkdocs
logo: img/logo.png
favicon: img/favicon.ico
theme.logoキーでロゴ画像を設定できます。
ロゴ画像はナビゲーションバーの左上に表示されます。
theme.faviconキーでファビコンを設定できます。
ファビコンはブラウザタブに表示されます。
フォントを設定したい(theme.font)
theme:
name: mkdocs
font:
text: Noto Sans JP
code: Source Code Pro
theme.fontセクションで表示フォントを指定できます。
指定したフォントがインストールされていることが前提です。