Internationalization (i18n)

Starlight Group Pages relies on Starlight’s built-in support for internationalization to provide multilingual support. Follow the Starlight “Configure i18n” guide and the Starlight Group Pages plugin creates group pages for every language of your website.

Translated content

Group pages use the content of the current language:

• Group titles and link card labels use the translated labels of your sidebar, e.g. set with the translations property of a group.
• Link cards of untranslated pages link to their fallback content, like the sidebar.
• Automatic descriptions follow the list conventions of the current language, e.g. “A, B und C” in German.

Translate the UI

The Starlight Group Pages plugin allows you to translate the default UI strings so that your website can be fully localized and readers can enjoy a seamless experience in their preferred language.

Chinese (China), Chinese (Taiwan), Dutch, English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, and Ukrainian translated UI strings are provided out of the box.

To provide translations for additional languages you support — or override the default ones — check the “Translate Starlight’s UI” guide in the Starlight documentation.

These are the English defaults of the existing strings Starlight Group Pages ships with:

{
  "starlightGroupPages.sidebarLink": "Overview"
}

The starlightGroupPages.sidebarLink string is the label of the “Overview” sidebar link, which is not used when the sidebarLink option is set to label.