Internationalization (i18n)

The Starlight Versions plugin relies on Starlight’s built-in support for internationalization to provide multilingual support for your versioned documentation.

See the Starlight internationalization documentation for more information on how to configure i18n in your Starlight website.

Configure i18n

Configure internationalization in your Starlight project by following the Starlight “Configure i18n” guide.

Translate the UI

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

English 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 Versions ships with:

{
  "starlightVersions.link.latest": "Switch to the <a href={{link}}>latest version</a> for up-to-date documentation.",
  "starlightVersions.outdated.label": "This content is for {{label}}.",
  "starlightVersions.outdated.slug": "This content is for the {{slug}} version.",
  "starlightVersions.search.link.latest": "Switch to the <a href={{link}}>latest version</a> for up-to-date results.",
  "starlightVersions.search.outdated.label": "Search limited to {{label}}.",
  "starlightVersions.search.outdated.slug": "Search limited to the {{slug}} version.",
  "starlightVersions.select.accessibleLabel": "Select version"
}