I18n

Setting Language important

You need to set the lang option for each language.

Even if you are only using a single language, you must set the lang in .vuepress/config.{js,ts} when you are not using the default en-US.

Why setting it?

To provide the correct locale text, the theme needs to know which language every directory is using.

Single Language

import { 
defineUserConfig
 } from "vuepress";

export default 
defineUserConfig
({
  // Set language you are using
  
lang
: "en-US",
});

Multi Language

import { 
defineUserConfig
 } from "vuepress";

export default 
defineUserConfig
({
  
locales
: {
    "/": {
      // Set language you are using
      
lang
: "en-US",
    },
    "/zh/": {
      // Set language you are using
      
lang
: "zh-CN",
    },
  },
});

Internationalization

locales is an object whose key is the path prefix of each language, and value is the configuration of this language. The value object can include title, description, lang, etc.

If the locales objects only contain the "/" key, then the site is not considers as a multi-language site.

Info

For details of multiple languages, please see Official Document

Supported Languages

• Simplified Chinese (zh-CN)
• Traditional Chinese (zh-TW)
• English (United States) (en-US)
• German (de-DE)
• German (Australia) (de-AT)
• Russian (ru-RU)
• Ukrainian (uk-UA)
• Vietnamese (vi-VN)
• Portuguese (Brazil) (pt-BR)
• Polish (pl-PL)
• French (fr-FR)
• Spanish (es-ES)
• Slovak (sk-SK)
• Japanese (ja-JP)
• Turkish (tr-TR)
• Korean (ko-KR)
• Finnish (fi-FI)
• Indonesian (id-ID)
• Dutch (nl-NL)

Note

If you need multi-language support for other languages, you can set locales for theme and plugins, this also gives you the ability to customize built-in locales. For details, see Theme I18n Options.

We also welcome you to submit PR to add new languages to all files named locale.ts or under locale folder in repo.

Setting Options for Each Language

Like the Site Config and Theme Config of @vuepress/theme-default, vuepress-theme-hope also supports locales in theme options, so you can set different config for each language.

import { 
defineUserConfig
 } from "vuepress";
import { 
hopeTheme
 } from "vuepress-theme-hope";

export default 
defineUserConfig
({
  
locales
: {
    "/": {
      
lang
: "en-US",
    },
    "/zh/": {
      
lang
: "zh-CN",
    },
  },

  
theme
: 
hopeTheme
({
    // common config
    // ...
    
locales
: {
      "/": {
        // config for English
        // ...
      },
      "/zh/": {
        // config for Chinese
        // ...
      },
    },
  }),
});