跳到主要内容
版本：Canary 🚧

i18n - 教程

本教程将带您了解Docusaurus i18n 系统的基础知识。

我们将法语翻译添加到新初始化的英文 Docusaurus 网站。

初始化一个新的网站npx create-docusaurus@latest website classic(像这个)。

配置您的站点​

修改docusaurus.config.js以添加对法语的 i18n 支持。

网站配置​

使用site i18n 配置来声明 i18n 区域设置:

docusaurus.config.js
module.exports = {
  i18n: {
    defaultLocale: "en",
    locales: ["en", "fr", "fa"],
    localeConfigs: {
      en: {
        htmlLang: "en-GB",
      },
      // You can omit a locale (e.g. fr) if you don't need to override the defaults
      fa: {
        direction: "rtl",
      },
    },
  },
};

语言环境名称用于翻译文件的位置，以及翻译后的语言环境的基础 URL。在构建所有区域设置时，只有默认区域设置的名称会在基 URL 中被省略。

Docusaurus 使用语言环境名称来提供合理的默认值:<html lang="...">属性、区域标签、日历格式等。您可以使用localeConfigs自定义这些默认值。

主题配置​

添加一个localeDropdown类型的导航栏项，以便用户可以选择他们想要的区域设置:

docusaurus.config.js
module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          type: "localeDropdown",
          position: "left",
        },
      ],
    },
  },
};
提示

您可以传递一个查询参数，当用户使用下拉菜单更改区域设置时，该参数将追加到 URL (如。 queryString: '?persistLocale=true').

这对于在服务器上实现自动区域设置检测非常有用。例如，您可以使用该参数在 cookie 中存储用户的首选区域设置。

启动您的网站​

在开发模式下启动本地化的站点，使用您选择的区域设置:

npm run start -- --locale fr

您的网站可通过http://localhost:3000/fr/访问。

我们还没有提供任何翻译，所以这个网站基本上是未翻译的。

提示

Docusaurus 为通用主题标签提供默认翻译，例如分页的“Next”和“Previous”。

请帮助我们完成这些**默认翻译**.

警告

每个语言环境都是一个独立的单页应用程序:不可能同时在所有语言环境中启动 Docusaurus 站点。

翻译你的网站​

法语地区的所有翻译数据都存储在website/i18n/fr中。 每个插件都在相应的文件夹下提供自己的翻译内容，而code.json文件定义了 React 代码中使用的所有文本标签。

备注

复制文件后，用npm run start -- --locale fr重新启动你的站点。在编辑现有文件时，热加载效果会更好。

翻译你的 React 代码​

对于你自己编写的任何 React 代码

页面，React 组件等，你将使用翻译 api.

找到 React 代码中所有对用户可见的文本标签，并用翻译 api 标记它们。有两种 api:

  • <Translate>组件将字符串包装为 JSX 元素;
  • translate()回调函数接受一条消息并返回一个字符串。

使用更符合上下文语义的那个。例如，<Translate>可以用作 React 的子元素，而对于期望字符串的 props，可以使用回调。

警告

JSX 元素是一个对象，而不是字符串。在需要字符串的上下文中使用它(例如<option>的子对象)将将其强制转换为字符串，它返回' ' "[object Object]"。 虽然我们鼓励您使用<Translate>作为 JSX 的子元素，但只有在元素形式真正起作用时才使用它。

src/pages/index.js
import React from "react";
import Layout from "@theme/Layout";
import Link from "@docusaurus/Link";

export default function Home() {
  return (
    <Layout>
      <h1>Welcome to my website</h1>
      <main>
        You can also visit my
        <Link to="https://docusaurus.io/blog">blog</Link>
        <img
          src="/img/home.png"
          alt="Home icon"
        />
      </main>
    </Layout>
  );
}
信息

Docusaurus 提供了一个非常小和轻量级的翻译运行时，并且只支持基本的占位符插值，使用ICU 消息格式的一个子集。

大多数文档网站通常是静态的，不需要高级的 i18n 功能(复数，性别等)。对于更高级的用例，可以使用像react-intl这样的库。

docusaurus write-translations命令将静态分析站点中使用的所有 React 代码文件，提取对这些 api 的调用，并将它们聚合到code.json 文件中。 翻译文件将存储为从 id 到翻译消息对象的映射(包括翻译后的标签和标签的描述)。 在调用翻译 API (<Translate>或translate())时，您需要指定默认的未翻译消息或 ID，以便 Docusaurus 正确地将每个翻译条目与 API 调用关联起来。

文本标签必须是静态的

docusaurus write-translations命令只对代码进行静态分析。 它实际上并不运行您的站点。因此，动态消息不能被提取，因为消息是一个表达式，而不是字符串:

const items = [
  {id: 1, title: 'Hello'},
  {id: 2, title: 'World'},
];

function ItemsList() {
  return (
    <ul>
      {/* DON'T DO THIS: doesn't work with the write-translations command */}
      {items.map((item) => (
        <li key={item.id}>
          <Translate>{item.title}</Translate>
        </li>
      ))}
    <ul>
  );
}

这在运行时仍能正常运行。然而，在未来，我们可能会提供一种“无运行时”机制，允许通过 Babel 转换将翻译直接内联到 React 代码中，而不是在运行时调用 api。因此，为了保证将来的安全，您应该始终选择静态可分析的消息。例如，我们可以将上面的代码重构为:

const items = [
  {id: 1, title: <Translate>Hello</Translate>},
  {id: 2, title: <Translate>World</Translate>},
];

function ItemsList() {
  return (
    <ul>
      {/* The titles are now already translated when rendering! */}
      {items.map((item) => (
        <li key={item.id}>{item.title}</li>
      ))}
    <ul>
  );
}

你可以把对翻译 api 的调用看作是纯粹的标记，它告诉 Docusaurus“这里有一个文本标签，要用翻译后的消息替换”。

多元化的案例​

当你运行write-translations时，你会注意到一些标签是复数形式的:

i18n/en/code.json
{
  // ...
  "theme.blog.post.plurals": "One post|{count} posts"
  // ...
}

每种语言都有一个可能的复数类别列表。 Docusaurus 会按照["zero", "one", "two", "few", "many", "other"]的顺序排列它们。 例如，由于英语(en)有两种复数形式(“one”和“other”)，翻译消息有两个由管道(|)分隔的标签。 对于有三种复数形式(“one”，“few”和“many”)的波兰语(pl)，您将按该顺序提供三个标签，并由管道连接。

你也可以将自己代码中的信息复数化:

import {translate} from '@docusaurus/Translate';
import {usePluralForm} from '@docusaurus/theme-common';

function ItemsList({items}) {
  // `usePluralForm` will provide the plural selector for the current locale
  const {selectMessage} = usePluralForm();
  // Select the appropriate pluralized label based on `items.length`
  const message = selectMessage(
    items.length,
    translate(
      {message: 'One item|{count} items'},
      {count: items.length},
    ),
  );
  return (
    <>
      <h2>{message}</h2>
      <ul>{items.map((item) => <li key={item.id}>{item.title}</li>)}<ul>
    </>
  );
}
备注

Docusaurus 使用Intl.PluralRules来解析和选择复数形式。 为selectMessage的工作提供正确数量和顺序的复数形式是很重要的。

翻译插件数据​

JSON 翻译文件用于散布在代码中的所有内容:

  • React 代码，包括上面标记的翻译后的标签
  • 主题配置中的导航栏和页脚标签
  • 文档侧边栏类别标签在 sidebars.js 中
  • 插件选项中的博客侧边栏标题
  • ...

运行write-translations 命令:

npm run write-translations -- --locale fr

它将提取并初始化需要翻译的 JSON 翻译文件。 根目录下的code.json文件包含从源代码中提取的所有翻译 API 调用，这些调用可以是由您编写的，也可以是由主题提供的，其中一些可能已经默认翻译了。

i18n/fr/code.json
{
  // No ID for the <Translate> component: the default message is used as ID
  "Welcome to my website": {
    "message": "Welcome to my website"
  },
  "home.visitMyBlog": {
    "message": "You can also visit my {blog}",
    "description": "The homepage message to ask the user to visit my blog"
  },
  "homepage.visitMyBlog.linkLabel": {
    "message": "Blog",
    "description": "The label for the link to my blog"
  },
  "Home icon": {
    "message": "Home icon",
    "description": "The homepage icon alt message"
  }
}

插件和主题也将编写自己的 JSON 翻译文件，例如:

i18n/fr/docusaurus-theme-classic/navbar.json
{
  "title": {
    "message": "My Site",
    "description": "The title in the navbar"
  },
  "item.label.Docs": {
    "message": "Docs",
    "description": "Navbar item with label Docs"
  },
  "item.label.Blog": {
    "message": "Blog",
    "description": "Navbar item with label Blog"
  },
  "item.label.GitHub": {
    "message": "GitHub",
    "description": "Navbar item with label GitHub"
  }
}

翻译i18n/frJSON 文件中的message属性，你的网站布局和主页现在应该被翻译了。

翻译 Markdown 文件​

官方 Docusaurus 内容插件广泛使用 Markdown/MDX 文件，并允许您翻译它们。

翻译文档​

将你的 docs Markdown 文件从docs/复制到i18n/fr/docusaurus-plugin-content-docs/current，并翻译它们:

mkdir -p i18n/fr/docusaurus-plugin-content-docs/current
cp -r docs/** i18n/fr/docusaurus-plugin-content-docs/current
信息

注意docusaurus-plugin-content-docs插件总是将其内容按版本划分。 ./docs文件夹中的数据将在current子文件夹和current.json文件中进行翻译。 请参阅文档版本控制指南了解有关"current"含义的更多信息。

翻译博客​

复制你的博客 Markdown 文件到i18n/fr/docusaurus-plugin-content-blog，并翻译它们:

mkdir -p i18n/fr/docusaurus-plugin-content-blog
cp -r blog/** i18n/fr/docusaurus-plugin-content-blog

翻译页面​

复制你的页面 Markdown 文件到i18n/fr/docusaurus-plugin-content-pages，并翻译它们:

mkdir -p i18n/fr/docusaurus-plugin-content-pages
cp -r src/pages/**.md i18n/fr/docusaurus-plugin-content-pages
cp -r src/pages/**.mdx i18n/fr/docusaurus-plugin-content-pages
警告

我们只复制.md 和 .mdx文件，因为 React 页面已经通过 JSON 翻译文件进行了翻译。

使用明确的标题 id

默认情况下，Markdown 标题### Hello World 将生成一个 IDhello-world。 其他文档可以用[link](#hello-world)”链接它。 然而，翻译后，标题变成了### Bonjour le Monde，ID 为bonjour-le-monde。

生成的 id 并不总是适合本地化的网站，因为它需要你本地化所有的锚链接:

- [link](#hello-world).
+ [link](#bonjour-le-monde)

对于本地化的站点，建议使用**显式标题 id**。

部署您的站点​

您可以选择将站点部署在单个域或使用多个(子)域。

单极部署​

运行以下命令:

npm run build

Docusaurus 将为每个地区构建一个单页应用程序:

  • website/build: 默认为英语语言
  • website/build/fr: 法语版

现在，您可以将“build”文件夹部署到您选择的静态托管解决方案。

备注

Docusaurus v2 网站使用了这种策略:

提示

静态主机提供商通常按照约定将/unknown/url重定向到/404.html，总是显示一个英文 404 页面。

本地化您的 404 页面配置您的主机重定向/fr/* 道 /fr/404.html。

这并不总是可能的，并且取决于您的主机

Pages 不能这样做，netflix可以。

多域部署​

您还可以为单一区域设置构建站点:

npm run build -- --locale fr

Docusaurus 不会添加/fr/ URL 前缀。

关于你的静态主机提供商:

  • 为每个区域设置创建一个部署
  • 使用--locale选项配置适当的构建命令
  • 为每个部署配置您选择的(子)域
警告

这种策略不可能与 GitHub 页面，因为它只可能有一个单一的部署。

混合动力​

可以让一些区域使用子路径，而其他区域使用子域。

也可以将每个区域设置部署为单独的子域，在 CDN 级别将子域组装在单个统一域中:

  • 将您的站点部署为fr.docusaurus.io
  • 配置一个 CDN 从“docusaurus.io/fr”提供它。

管理翻译​

Docusaurus 并不关心您如何管理翻译:它所需要的只是在构建过程中所有翻译文件(JSON、Markdown 或其他数据文件)在文件系统中可用。然而，作为站点创建者，您需要考虑如何管理翻译，以便您的翻译贡献者能够很好地合作。

我们将分享两种常见的翻译协作策略:使用 git和使用 Crowdin。

编辑此页
最后由 wohugb@aliyun.com 于 更新