https://github.com/hideoo/starlight-i18n

Visual Studio Code extension - Easily translate Starlight documentation pages.
https://github.com/hideoo/starlight-i18n

documentation extension i18n internationalization starlight translation vscode

Last synced: 3 months ago
JSON representation

Visual Studio Code extension - Easily translate Starlight documentation pages.

• Host: GitHub
• URL: https://github.com/hideoo/starlight-i18n
• Owner: HiDeoo
• License: mit
• Created: 2023-09-12T08:12:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-04T10:09:27.000Z (about 1 year ago)
• Last Synced: 2024-10-04T16:54:25.648Z (4 months ago)
• Topics: documentation, extension, i18n, internationalization, starlight, translation, vscode
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=hideoo.starlight-i18n
• Size: 109 KB
• Stars: 14
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Starlight i18n





  
Easily translate Starlight documentation pages.

  


    

      

    

    

      

    

  

  


    

      

    

  



## Features

Visual Studio Code extension to easily translate [Starlight](https://starlight.astro.build/) documentation pages using the built-in [support for multilingual sites](https://starlight.astro.build/guides/i18n/) and [git](https://git-scm.com/).

- 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](https://code.visualstudio.com/docs/getstarted/userinterface#_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](https://docs.astro.build/en/guides/configuring-astro/#supported-config-file-types) 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](https://code.visualstudio.com/docs/getstarted/settings#_settings-editor) or [Workspace](https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings) settings.

```json

{

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

}

```

## More extensions

- [Toggler](https://marketplace.visualstudio.com/items?itemName=hideoo.toggler) - Toggle words and symbols.

- [Create](https://marketplace.visualstudio.com/items?itemName=hideoo.create) - Quickly create new File(s) & Folder(s).

- [Trailing](https://marketplace.visualstudio.com/items?itemName=hideoo.trailing) - Toggle trailing symbols: commas, semicolons and colons.

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/starlight-i18n/blob/main/LICENSE) for more information.