Use `i18next` for UI strings and add new `injectTranslations` plugin callback by HiDeoo · Pull Request #1923 · withastro/starlight

HiDeoo · 2024-05-22T14:23:38Z

This PR is currently based on #1841.

Description

Closes Starlight localization API proposal #1496 and also relates to the Starlight plugins proposal #962 proposal

This PR:

Adds a new injectTranslations plugin callback for plugins to inject translations to Starlight.
Refactors the UI strings/translations to a middleware.
Refactors the UI strings/translations to use i18next.
Exposes UI strings/translations API to users and plugins.

Note that the links validation is failing a lot but this is expected as the links validator plugin does not support the configuration syntax based on #1841.

Remaining tasks

* main: i18n(zh-cn): Update docs about synced-tabs (withastro#1834) i18n(zh-cn): Update some docs about withastro#1620 & withastro#1613 (withastro#1835) Add more diagnostic help to error messages thrown by `<Steps>` (withastro#1838) i18n(zh-cn): Update components.mdx (withastro#1836) i18n(zh-cn): Update community-content.mdx (withastro#1833) Improve type checking job (withastro#1831) [ci] format [ci] release (withastro#1832) i18n(ru): update ru.json (withastro#1826) Fix `<Tabs>` sync issue with inconsistent use of `icon` on `<TabItem>` components (withastro#1811) Enable `BASE_URL` tests (withastro#1828)

* main: i18n(zh-cn): Update `components.mdx` translation (withastro#1852)

* main: (45 commits) i18n(tr): add `showcase.mdx` (withastro#1896) [ci] format i18n(zh-cn): Update `authoring-content.md` (withastro#1901) [ci] format [ci] release (withastro#1897) [ci] format i18n(tr): update `authoring-content.md` (withastro#1887) Micro-optimization: clean up `<details>` CSS (withastro#1892) [ci] format i18n(tr): update `components.md` file (withastro#1889) [ci] format i18n(tr): add css-and-tailwind (withastro#1893) [ci] format [ci] release (withastro#1890) Adds custom styles for `<details>` and `<summary>` elements in Markdown content (withastro#1735) Update @astrojs/mdx to v3 (withastro#1846) [ci] format [ci] release (withastro#1869) Add BlueSky social icon (withastro#1871) [ci] format ...

changeset-bot · 2024-05-22T14:23:42Z

🦋 Changeset detected

Latest commit: 9dad875

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@astrojs/starlight	Minor
@astrojs/starlight-docsearch	Minor

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

astrobot-houston · 2024-05-22T14:24:14Z

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale	File	Note
en	guides/i18n.mdx	Source changed, localizations will be marked as outdated.
en	reference/overrides.md	Source changed, localizations will be marked as outdated.
en	reference/plugins.md	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

.changeset/cool-experts-sort.md

docs/src/content/docs/reference/plugins.md

Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>

sarah11918

Y'all are just too good at this! I am so happy to see this accomplishment, and really proud to be associated with the quality of work in this project!

One tiny thought I had while reading the changeset, but the docs are fantastic.

sarah11918 · 2024-09-17T22:49:04Z

.changeset/cool-experts-sort.md

+'@astrojs/starlight': minor
+---
+
+Overhauls the built-in localization system which is now powered by the [`i18next`](https://www.i18next.com/) library and available to use anywhere in your documentation website.


If applicable, it might be worth a note re: if there is anyone who might have a multi-language site who does NOT need to do anything differently.

Does this only affect people who want to access/render the strings themselves, like in new UI elements they build? Is it possible that there are people with very basic sites with multiple languages where the built in "previous/next page" etc. is all they use and will still just work? Or is it assumed that EVERYONE with a multi-language site will need to update?

Overhauls the built-in localization system which is now powered by the [`i18next`](https://www.i18next.com/) library and available to use anywhere in your documentation website. This update includes more features and potentially breaking changes for those who created custom, translated, UI elements. Starlight's built-in elements available by configuring support for a language have not changed.

Like, that may be totally wrong, but if there's a clean way of saying what people don't have to worry about/update, I think that's helpful to lead in here, especially when there is a breaking change.

I think this is already clear from the breaking change section? It says this only applies if you were using component overrides.

delucis

Everything looks good to me! This is a very exciting feature to be added. Excited to see what people do with and excited to see if we got anything wrong 😁

Thank you again @HiDeoo — all yours to merge! 🌟

…callback (withastro#1923) Co-authored-by: Chris Swithinbank <357379+delucis@users.noreply.github.com> Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>

HiDeoo added 24 commits May 5, 2024 10:54

chore: bump required astro version to 4.4.5

6b3d657

fix: refactor UserI18nSchema type

4c1af27

refactor: add built-in default locale

bbb95ff

feat: generate and use Astro i18n config

2ee987e

feat: add Astro → Starlight i18 config support

3dbedb2

feat: use Astro i18n config in docs for demo purposes

f8e36b2

Merge branch 'main' into hd-refactor-astro-i18n

802b6d4

* main: i18n(zh-cn): Update `components.mdx` translation (withastro#1852)

chore: bump astro version to 4.8.0

e30c18b

feat: add support for Astro i18m manual routing strategy

5c2c844

chore: bump astro version to 4.8.6

e731ab3

test: update i18n-non-root-single-locale test

b079bd7

chore: remove tsconfig allowJs unneeded option

2498bee

feat: add i18next support

a201d3d

feat: add t.dir()

ed63fb6

refactor: improve typings

06d9230

feat: add demo custom plugin

609fc1d

feat: update @astrojs/starlight-docsearch plugin

fc86eb8

docs: add debug page

c07edb2

docs: remove labels route props documentation

3c71f45

chore: remove comments

7dfda98

fix: add support for t.exists() options

c2b2185

docs: add documentation for injectTranslations and locals.t

f576a19

github-actions bot added 📚 docs Documentation website changes 🌟 core Changes to Starlight’s main package labels May 22, 2024

This comment was marked as outdated.

Sign in to view

HiDeoo marked this pull request as draft May 22, 2024 14:24

HiDeoo and others added 6 commits September 17, 2024 18:57

chore: remove debug content

6f2ec48

chore: remove debug banner

39c454c

chore: remove Astro i18n config

c528ee0

test: update coverage thresholds

b757dc6

chore: add changesets

f2f9208

Make docs more “guide-like” in i18n guide

6fc6268

HiDeoo commented Sep 17, 2024

View reviewed changes

.changeset/cool-experts-sort.md Outdated Show resolved Hide resolved

docs/src/content/docs/reference/plugins.md Outdated Show resolved Hide resolved

Fix careless find/replacing

6a8cef0

Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>

sarah11918 approved these changes Sep 17, 2024

View reviewed changes

feat: @astrojs/starlight-docsearch peer dependency

c2d716f

github-actions bot added 🌟 tailwind Changes to Starlight’s Tailwind package 🌟 markdoc Changes to Starlight’s Markdoc package labels Sep 18, 2024

feat: @astrojs/starlight Astro peer dependency bump

4b80afc

delucis approved these changes Sep 18, 2024

View reviewed changes

Merge branch 'main' into hd-i18next

9dad875

HiDeoo merged commit 5269aad into withastro:main Sep 18, 2024

HiDeoo deleted the hd-i18next branch September 18, 2024 07:55

astrobot-houston mentioned this pull request Sep 18, 2024

[ci] release #2332

Merged

This was referenced Sep 18, 2024

i18n(ko-KR): update i18n.mdx and plugins.md #2336

Merged

i18n(ko-KR): update overrides.md #2338

Merged

This was referenced Sep 18, 2024

i18n(fr): update reference/overrides #2340

Merged

i18n(fr): update reference/plugins & guides/i18n #2341

Merged

This was referenced Sep 24, 2024

i18n(zh-cn): Update overrides.md #2404

Merged

i18n(zh-cn): Update plugins.md & i18n.mdx #2412

Merged

huijing mentioned this pull request Oct 3, 2024

The labels prop in component overrides has been removed lorenzolewis/starlight-utils#104

Closed

riderx mentioned this pull request Oct 23, 2024

[Snyk] Upgrade @astrojs/starlight from 0.27.1 to 0.28.2 Cap-go/website#261

Closed

Sujit-AI-Sec mentioned this pull request Oct 27, 2024

[Snyk] Upgrade @astrojs/starlight from 0.26.1 to 0.28.2 Sujit-AI-Sec/Realworld#15

Open

morinokami mentioned this pull request Nov 4, 2024

i18n(ja): Update overrides.md #2567

Merged

ajile-in mentioned this pull request Nov 4, 2024

[Snyk] Upgrade @astrojs/starlight from 0.22.4 to 0.28.3 credebl/studio#814

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use `i18next` for UI strings and add new `injectTranslations` plugin callback#1923

Use `i18next` for UI strings and add new `injectTranslations` plugin callback#1923
HiDeoo merged 62 commits intowithastro:mainfrom
HiDeoo:hd-i18next

HiDeoo commented May 22, 2024 •

edited by delucis

Loading

Uh oh!

changeset-bot bot commented May 22, 2024 •

edited

Loading

Uh oh!

This comment was marked as outdated.

astrobot-houston commented May 22, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

sarah11918 left a comment

Uh oh!

sarah11918 Sep 17, 2024

Uh oh!

delucis Sep 18, 2024

Uh oh!

delucis left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

HiDeoo commented May 22, 2024 • edited by delucis Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Remaining tasks

Uh oh!

changeset-bot bot commented May 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

This comment was marked as outdated.

astrobot-houston commented May 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Lunaria Status Overview

Tracked Files

Uh oh!

Uh oh!

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

sarah11918 Sep 17, 2024

Choose a reason for hiding this comment

Uh oh!

delucis Sep 18, 2024

Choose a reason for hiding this comment

Uh oh!

delucis left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

HiDeoo commented May 22, 2024 •

edited by delucis

Loading

changeset-bot bot commented May 22, 2024 •

edited

Loading

astrobot-houston commented May 22, 2024 •

edited

Loading