本地化您的主题

以您偏好的语言显示您的主题。

---

注意： 主题本地化仅翻译主题本身的文本元素（例如“下一页”和“上一页”链接），而不是文档的实际内容。如果您希望创建多语言文档，您需要结合此处描述的主题本地化与第三方国际化/本地化插件。

安装

要使主题本地化生效，您必须使用支持本地化的主题，并通过安装 mkdocs[i18n] 来启用 i18n（国际化）支持：

pip install 'mkdocs[i18n]'

支持的语言环境

在大多数情况下，语言环境由您的语言的 ISO-639-1（2 字母）缩写指定。然而，语言环境也可能包括一个地区（或区域或国家）代码。语言和地区必须用下划线分隔。例如，英语的一些可能的语言环境包括 en、en_AU、en_GB 和 en_US。

有关您使用的主题支持的语言环境列表，请参阅该主题的文档。

• mkdocs
• readthedocs

警告： 如果您配置了一个您使用的主题尚未支持的语言环境，MkDocs 将回退到主题的默认语言环境。

使用方法

要指定 MkDocs 应使用的语言环境，请将 theme 配置选项的 locale 参数设置为适当的代码。

例如，要将 mkdocs 主题构建为法语，您可以在 mkdocs.yml 配置文件中使用以下内容：

theme:
  name: mkdocs
  locale: fr

贡献主题翻译

如果某个主题尚未翻译成您的语言，欢迎您使用 翻译指南 贡献翻译。