i18n - 教程
本教程将为你阐述 Docusaurus i18n 系统的基础。
我们将为新建的英文 Docusaurus 站点添加简体中文翻译。
首先,用 npx create-docusaurus@latest init website classic
来创建新站点。(就像这个一样)
配置你的站点
编辑 docusaurus.config.js
,添加对简体中文语言的 i18n 支持。
站点配置
使用站点的 i18n 配置来声明要国际化的语言:
docusaurus.config.js
export default {
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',
},
},
},
};
语言名称会被用于翻译文件的位置以及你的本地化网站的 base URL。 构建所有语言时,只有默认语言才会在 base URL 中省略它的名字。
Docusaurus 会用语言名称提供合理默认值:<html lang="...">
属性、语言标签、日历格式等。 你可以用 localeConfigs
自定义这些默认值。
主题配置
添加 localeDropdown
类型的导航栏下拉框,让用户选择语言:
docusaurus.config.js
export default {
themeConfig: {
navbar: {
items: [
{
type: 'localeDropdown',
position: 'left',
},
],
},
},
};
提示
You can pass a query parameter that will be appended to the URL when a user changes the locale using the dropdown (e.g. queryString: '?persistLocale=true'
).
This is useful for implementing an automatic locale detection on your server. For example, you can use this parameter to store the user's preferred locale in a cookie.
我们还没有添加任何译文,所以网站的大部分内容都没有被翻译。