Implement UI string translation using data collections #78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 898aa56 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for astro-starlight ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
size-limit report 📦
|
|
This looks great @delucis but I'm wondering if you need to change something else in the astro.config.mjs file to be able to see the updated UI in german? |
|
It works in the preview 😃 |
Support supplying translation strings as part of starlight package so that users hopefully don’t need to do it themselves.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of changes does this PR include?
Description
Users can provide translations in JSON files in
src/content/i18n/which is a data collection, for example asrc/content/i18n/de.json:{ "search.label": "Suchen", "search.shortcutLabel": "(Drücke / zum Suchen)" }In Starlight templates, we look up strings for the current locale from this data collection, falling back to the user-configured default locale, or to Starlight’s English defaults. This PR also adds built-in support for Spanish & German. The aim would be that for major languages we provide language support out of the box and users only need manual config to override labels or if they support less common languages.
Not included
Mapping languages to dictionaries is a bit basic so far, e.g.
de-CHwouldn’t finddetranslations. Leaving that to a follow-up PR, e.g with a library like https://github.com/wooorm/bcp-47-match