国际化
要使用内置的 i18n 功能,需要创建如下的目录结构:
docs/
├─ es/
│ ├─ foo.md
├─ fr/
│ ├─ foo.md
├─ foo.md
└─ index.md
然后在 docs/.vitepress/config.js
中指定 locales
选项:
js
export default {
// 共享属性和其他顶级内容...
locales: {
root: {
label: 'English',
lang: 'en'
},
fr: {
label: 'French',
lang: 'fr',
link: '/fr/guide'
},
es: {
label: 'Spanish',
lang: 'es',
link: '/es/guide'
}
}
}
以下配置选项可以为每个语言环境(包括根目录)重写:
ts
interface LocaleSpecificConfig<ThemeConfig = any> {
lang?: string
dir?: string
title?: string
titleTemplate?: string | boolean
description?: string
head?: HeadConfig[] // 将与现有头部条目合并,重复的元标记将自动删除
themeConfig?: ThemeConfig // 将进行浅层合并,常见内容可以放在顶层 themeConfig 条目中
}
请参考DefaultTheme.Config
接口以获取自定义默认主题的占位符文本的详细信息。不要在运行时覆盖 themeConfig.algolia
或 themeConfig.carbonAds
,请参考 Algolia Docs 了解更多详细信息。
为每个语言环境设置单独的目录
以下是完全可以接受的结构:
docs/
├─ en/
│ ├─ foo.md
├─ es/
│ ├─ foo.md
├─ fr/
├─ foo.md
但是,VitePress 默认不会将 /
重定向到 /en/
。你需要为此配置服务器。例如,在 Netlify 上,你可以添加一个 docs/public/_redirects
文件,如下所示:
/* /es/:splat 302 Language=es
/* /fr/:splat 302 Language=fr
/* /en/:splat 302
RTL 支持(实验性)
对于 RTL 支持,在配置中指定 dir: 'rtl'
,并使用一些 RTLCSS PostCSS 插件,如 https://github.com/MohammadYounes/rtlcss、https://github.com/vkalinichev/postcss-rtl 或 https://github.com/elchininet/postcss-rtlcss。你需要配置 PostCSS 插件以使用 :where([dir="ltr"])
和 :where([dir="rtl"])
作为前缀,以防止 CSS 特异性问题。