翻译¶
这令人难以置信——在国际社区的贡献帮助下,Material for MkDocs 已经被翻译成 60 多种语言。可以想象,对于我们这些维护者来说,保持所有语言的最新状态几乎是不可能的,而新功能有时也需要新的翻译。
如果您希望帮助我们使 Material for MkDocs 更加全球化,并且注意到您的语言缺少翻译,或者想要添加一种新语言,您可以按照下面指南的步骤来帮助我们。
在创建问题之前¶
翻译经常会发生变化,这就是我们希望确保您不会浪费时间重复工作的原因。在添加翻译之前,请检查以下事项:
检查语言可用性¶
有超过 60 种语言,您的语言很可能已经得到了 Material for MkDocs 的支持。您可以通过检查 支持的语言 列表来查看您的语言是否可用,或者是否需要改进或额外的翻译:
-
您的语言已经得到支持 – 在这种情况下,您可以检查是否缺少翻译,并点击您语言下方的链接来添加它们,这只需 5 分钟。
-
您的语言缺失 – 在这种情况下,您可以帮助我们为 Material for MkDocs 添加对您语言的支持!继续阅读,了解如何做到这一点。
搜索我们的问题跟踪器¶
其他用户可能已经创建了一个问题,提供了您语言缺失的翻译,但仍需由我们维护者进行集成。为了避免浪费时间重复工作,请提前搜索 问题跟踪器。
在此时,当您确保 Material for MkDocs 尚未支持您的语言后,您可以按照问题模板添加新的翻译。
问题模板¶
我们创建了一个问题模板,使贡献翻译尽可能简单。它是我们在过去几年中处理 60 多种语言贡献和更新的经验的结果,包含以下部分:
标题¶
当您更新已经存在的语言时,可以保持标题不变。添加对新语言的支持时,请将预填标题中的 ... 替换为您的语言名称。
| 示例 | |
|---|---|
| 清晰 | 添加德语翻译 |
| 不清晰 | 添加翻译 ... |
| 无用 | 帮助 |
翻译¶
如果翻译右侧有一个 图标,则表示缺失。您可以翻译这一行并移除
图标。如果您不知道如何翻译特定行,可以将其留给其他贡献者完成。为了确保翻译的准确性,请考虑通过查看我们的 英文翻译 来仔细检查单词的上下文。
国家旗帜 可选¶
为了更好地概览,我们的 支持的语言 列表在语言名称旁边包含国家旗帜。您可以通过将国家旗帜的短代码添加到此字段来帮助我们选择您语言的旗帜。请访问我们的 emoji 搜索 并输入 flag 以查找所有可用的短代码。
如果我的旗帜不可用怎么办?
Twemoji 为 260 个国家提供旗帜表情符号——国家的子区域,如州、省或地区,不受支持。如果您为一个子区域添加翻译,请选择最合适的可用旗帜。
这可能有帮助的原因: 在国家名称旁边添加国家旗帜可以帮助您和其他人更快、更容易地在支持的语言列表中找到该语言。如果您的国家的旗帜未被 Twemoji 支持,您可以帮助我们选择一个替代方案。
检查清单¶
感谢您遵循指南并帮助我们为 Material for MkDocs 添加新的翻译——您快完成了。检查清单确保您已阅读本指南,并尽您所能为我们提供整合您贡献所需的一切。
接下来由我们来处理。
署名¶
如果您使用上述模板提交翻译,您将被 列为共同作者 在提交中,因此您无需打开拉取请求。您为该项目做出了重要贡献,使 Material for MkDocs 能够为更多人所用。谢谢您!