Skip to content

Интернационализация

Чтобы использовать встроенные функции интернационализации, необходимо создать следующую структуру каталогов:

docs/
├─ es/
│  ├─ foo.md
├─ fr/
│  ├─ foo.md
├─ foo.md

Затем в docs/.vitepress/config.ts:

ts
import { defineConfig } from 'vitepress'

export default defineConfig({
  // общие свойства и другие элементы верхнего уровня...

  locales: {
    root: {
      label: 'Английский',
      lang: 'en'
    },
    fr: {
      label: 'Французский',
      lang: 'fr', // необязательно, будет добавлено как атрибут `lang` в тег `html`
      link: '/fr/guide' // по умолчанию /fr/ -- отображается в меню переводов на панели навигации, может быть внешним

      // другие свойства, специфичные для локали...
    }
  }
})

Следующие свойства могут быть переопределены для каждой локали (включая root):

ts
interface LocaleSpecificConfig<ThemeConfig = any> {
  lang?: string
  dir?: string
  title?: string
  titleTemplate?: string | boolean
  description?: string
  head?: HeadConfig[] // будут объединены с существующими записями head, дублирующиеся мета-теги автоматически удаляются
  themeConfig?: ThemeConfig // будет объединено поверхностно, общие вещи могут быть помещены в запись themeConfig верхнего уровня
}

См. интерфейс DefaultTheme.Config для деталей настройки текстов-заполнителей стандартной темы. Не переопределяйте themeConfig.algolia или themeConfig.carbonAds на уровне локали. См. документацию Algolia для использования многоязычного поиска.

Профессиональный совет: Файл конфигурации может быть сохранен в docs/.vitepress/config/index.ts тоже. Это может помочь вам организовать вещи, создавая файл конфигурации для каждой локали, а затем объединяя и экспортируя их из index.ts.

Отдельный каталог для каждой локали

Следующая структура также является абсолютно приемлемой:

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

Профессиональный совет: Если используете вышеуказанный подход, вы можете использовать куки nf_lang для сохранения выбора языка пользователя:

ts
// docs/.vitepress/theme/index.ts
import DefaultTheme from 'vitepress/theme'
import Layout from './Layout.vue'

export default {
  extends: DefaultTheme,
  Layout
}
vue
<!-- docs/.vitepress/theme/Layout.vue -->
<script setup lang="ts">
import DefaultTheme from 'vitepress/theme'
import { useData } from 'vitepress'
import { watchEffect } from 'vue'

const { lang } = useData()
watchEffect(() => {
  if (inBrowser) {
    document.cookie = `nf_lang=${lang.value}; expires=Mon,

 1 Jan 2030 00:00:00 UTC; path=/`
  }
})
</script>

<template>
  <DefaultTheme.Layout />
</template>

Поддержка 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-специфичностью.

Содержание доступно по лицензии MIT