Docgeni can localize your site, config fields, and component docs. Declare supported languages in .docgenirc.ts, then place files for each language using the conventions below.

Enable multiple languages

Set locales (language list) and defaultLocale (fallback language):

ts
export default {
    locales: [
        { key: 'zh-cn', name: '中文' },
        { key: 'en-us', name: 'English' },
    ],
    defaultLocale: 'zh-cn',
};

• key: language id used in URLs, folders, and file names (e.g. zh-cn, en-us)
• name: label shown in the locale switcher
• defaultLocale: used when a translation is missing; must match one of the key values

If you only need one language, omit locales and the site is built for defaultLocale only.

Markdown docs

Put default-language pages directly under docs, e.g. docs/guides/....

For other languages, add a folder named after the key and mirror the same tree:

docs/
├── guides/              # default language (e.g. zh-cn)
│   └── intro/
│       └── getting-started.md
├── en-us/               # English
│   ├── guides/
│   │   └── intro/
│   │       └── getting-started.md
│   └── index.md
└── index.md

Docgeni generates top-level nav, categories, and pages per locale. Missing files for a locale may be skipped or fall back depending on the build.

Config fields

Fields such as title in .docgenirc.ts are in the default language. Add a locales object and override fields per key:

ts
export default {
    navs: [
        null,
        {
            title: 'Components',
            path: 'components',
            lib: 'alib',
            locales: {
                'zh-cn': {
                    title: '组件',
                },
            },
        },
    ],
};

The same pattern works for navs, library categories, and other config that supports locales.

Component docs and API

Under each component folder, split docs and API by language:

button/
├── doc/
│   ├── zh-cn.md    # overview (Markdown)
│   └── en-us.md
└── api/
    ├── zh-cn.ts    # API metadata (.json, .js, etc. per apiMode)
    └── en-us.ts

File names must match a key from locales. Shared fields like category and order live in the default-language Front Matter only.

See Library configuration and Component docs for details.

Quick reference

See Global configuration for the full locales option.