ローカルテーマ

ご希望の言語でテーマを表示します。

注意

テーマのローカリゼーションでは、テーマ自体のテキスト要素（「次へ」や「戻る」などのリンク）のみが翻訳され、ドキュメントの実際の内容は翻訳されません。多言語ドキュメントを作成する場合は、ここで説明するテーマのローカリゼーションを、サードパーティの国際化/ローカリゼーションプラグインと組み合わせて使用する必要があります。

インストール

テーマのローカリゼーションを機能させるには、それをサポートするテーマを使用し、mkdocs[i18n]をインストールしてi18n（国際化）サポートを有効にする必要があります。

pip install 'mkdocs[i18n]'

サポートしているロケール

ほとんどの場合、ロケールはISO-639-1（2文字）の言語略語で指定されます。ただし、ロケールにはテリトリー（地域または国）コードを含めることもできます。言語と地域はアンダースコアで区切る必要があります。たとえば、英語の可能なロケールには、en、en_AU、en_GB、en_USなどがあります。

使用しているテーマでサポートされているロケールのリストについては、そのテーマのドキュメントを参照してください。

警告

ご使用のテーマでまだサポートされていない言語ロケールを設定すると、MkDocsはテーマの既定のロケールに戻ります。

使用方法

MkDocsで使用するロケールを指定するには、ロケールパラメータをテーマ設定オプションで適切なコードに設定します。

たとえば、mkdocsテーマをフランス語で構築するには、次のようにmkdocs.yml設定ファイルを使用します。

theme:
  name: mkdocs
  locale: fr

テーマ翻訳の提供

テーマがまだあなたの言語に翻訳されていない場合は、翻訳ガイドを使用して翻訳に協力してください。