i18n - 使用 git
一种可行的翻译方法是通过 Git(或其他 VCS)来版本控制翻译文件。
利弊
这一方法有如下 优势:
- 易于上手:在 Git 上添加
i18n
文件夹即可 - 开发方便:Git、GitHub 及合并请求均为主流的开发者工具
- 免费(至少不需要额外费用,如果你已经使用 Git 的话)
- 工作量小:不需注册第三方工具
- 高反馈:贡献者乐于看到自己漂亮的贡献历史
但使用 Git 也存在一些劣势:
- 对非开发者不友好:他们并未掌握 Git 及合并请求
- 对专业译者不友好:他们惯于使用 SaaS 翻译软件与高级功能
- 难以维护:你必须保持已翻译和未翻译的文件同步
备注
有一些大规模的技术项目(如 React、Vue.js、MDN、TypeScript、Nuxt.js 等等)使用 Git 翻译。
请参见 Docusaurus i18n RFC 查看我们研究这些系统的链接与笔记。
初始化
This is a walk-through of using Git to translate a newly initialized English Docusaurus website into French, and assume you already followed the i18n tutorial.
准备 Docusaurus 站点
初始化新的 Docusaurus 站点:
npx create-docusaurus@latest website classic
添加简体中文版网站的配置:
docusaurus.config.js
module.exports = {
i18n: {
defaultLocale: 'en',
locales: ['en', 'zh-Hans'],
},
themeConfig: {
navbar: {
items: [
// ...
{
type: 'localeDropdown',
position: 'left',
},
// ...
],
},
},
// ...
};
翻译首页:
src/pages/index.js
import React from 'react';
import Translate from '@docusaurus/Translate';
import Layout from '@theme/Layout';
export default function Home() {
return (
<Layout>
<h1 style={{margin: 20}}>
<Translate description="The homepage main heading">
Welcome to my Docusaurus translated site!
</Translate>
</h1>
</Layout>
);
}
初始化 i18n
文件夹
Use the write-translations CLI command to initialize the JSON translation files for the French locale:
- npm
- Yarn
- pnpm
npm run write-translations -- --locale zh-Hans
1 translations written at i18n/zh-Hans/code.json
11 translations written at i18n/zh-Hans/docusaurus-theme-classic/footer.json
4 translations written at i18n/zh-Hans/docusaurus-theme-classic/navbar.json
3 translations written at i18n/zh-Hans/docusaurus-plugin-content-docs/current.json
yarn write-translations --locale zh-Hans
1 translations written at i18n/zh-Hans/code.json
11 translations written at i18n/zh-Hans/docusaurus-theme-classic/footer.json
4 translations written at i18n/zh-Hans/docusaurus-theme-classic/navbar.json
3 translations written at i18n/zh-Hans/docusaurus-plugin-content-docs/current.json
pnpm run write-translations -- --locale zh-Hans
1 translations written at i18n/zh-Hans/code.json
11 translations written at i18n/zh-Hans/docusaurus-theme-classic/footer.json
4 translations written at i18n/zh-Hans/docusaurus-theme-classic/navbar.json
3 translations written at i18n/zh-Hans/docusaurus-plugin-content-docs/current.json