Skip to content

HiDeoo/starlight-i18n

Repository files navigation

Starlight i18n extension icon

Starlight i18n

Easily translate Starlight documentation pages.

Integration Status License

Demo of the Starlight i18n extension

Features

Visual Studio Code extension to easily translate Starlight documentation pages using the built-in support for multilingual sites and git.

  • Collect supported languages from a Starlight configuration in a workspace repo or monorepo.
  • Pick a language and a page to translate.
  • Open side-by-side editors with the missing changes and the translated page for out-of-date pages.
  • Open side-by-side editors with the source page and a newly created page for missing translated pages.
  • Configurable Starlight configuration directories.

Usage

  1. Open a repository or monorepo containing a Starlight documentation website.
  2. Open the Visual Studio Code Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS)
  3. Run the Starlight i18n command

Configuration

By default, the Starlight i18n extension will look for a Starlight configuration in an Astro configuration file located either at the root of the workspace or in a docs/ subdirectory.

You can customize the directories where the extension will look for a Starlight configuration in your Visual Studio Code User or Workspace settings.

{
  "starlight-i18n.configDirectories": [".", "./docs", "./app", "./packages/docs"]
}

More extensions

  • Toggler - Toggle words and symbols.
  • Create - Quickly create new File(s) & Folder(s).
  • Trailing - Toggle trailing symbols: commas, semicolons and colons.

License

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.