在地化您的佈景主題

以您偏好的語言顯示您的佈景主題。


注意事項

佈景主題在地化僅能翻譯佈景主題本身的文字元素(例如「下一頁」和「上一頁」連結),並非實際的文件說明內容。如果您希望建立多語言文件說明,您需要將此處所述的佈景主題在地化與第三方國際化/在地化外掛程式相結合。

安裝

為使佈景主題在地化可順利運作,您一定要使用支援它的佈景主題並透過安裝 mkdocs[i18n] 來啟用 i18n(國際化)支援

pip install 'mkdocs[i18n]'

支援的地區

在大部分情況下,地區會由 ISO-639-1(2個字母)為您的語言進行縮寫。不過,地區也可以包含地區(或區域或縣/市)代碼。語言與地區必須用底線隔開。例如,英文的一些可能地區包括 enen_AUen_GBen_US.

如需查看您所使用佈景主題支援的地區清單,請參閱該佈景主題的文件說明。

警告

如果您設定的地區代碼尚未獲得您所使用佈景主題支援,MkDocs 會改用佈景主題的預設地區。

用法

如需指定 MkDocs 應使用的地區,請將 地區 參數設定為 佈景主題 組態選項,並調整為適當的代碼。

例如,如果要在法文中建立 mkdocs 佈景主題,您可以在 mkdocs.yml 組態檔案中使用下列設定

theme:
  name: mkdocs
  locale: fr

協助佈景主題翻譯

如果佈景主題尚未翻譯成您的語言,請隨時運用 翻譯指南 提供協助翻譯。