Skip to content

docs(next): add metadata translation example and link pluralization from quickstarts #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
moss-bryophyta wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(next): add metadata translation example and link pluralization from quickstarts #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/en-US/next/api/strings/get-gt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,26 @@ export default async function TranslateGreeting() {
```
Note: "Alice" will not be translated to the user's preferred language because it is a variable.

### Translating page metadata [#metadata]
Use `getGT` inside Next.js `generateMetadata` to translate page titles, descriptions, and Open Graph tags.

```javascript copy
import { getGT } from 'gt-next/server';
import { Metadata } from 'next';

export async function generateMetadata(): Promise<Metadata> {
const gt = await getGT();
return {
title: gt('My App'),
description: gt('A fast, modern web application'),
openGraph: {
title: gt('My App'),
description: gt('A fast, modern web application'),
},
};
}
```

### Using ICU message format

`gt-next` supports ICU message format, which allows you to also format your variables.
Expand Down
2 changes: 2 additions & 0 deletions docs/en-US/next/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,5 +329,7 @@ That's it — your app is now multilingual. 🎉
- [**`<T>` Component Guide**](/docs/next/guides/t) — Learn about variables, plurals, and advanced translation patterns
- [**String Translation Guide**](/docs/next/guides/strings) — Deep dive into `useGT` and `getGT`
- [**Variable Components**](/docs/next/guides/variables) — Handle dynamic content with `<Var>`, `<Num>`, `<Currency>`, and `<DateTime>`
- [**Pluralization**](/docs/next/api/components/plural) — Handle plural forms with the `<Plural>` component
- [**Translating Page Metadata**](/docs/next/api/strings/get-gt#metadata) — Translate titles, descriptions, and OG tags with `getGT`
- [**Deploying to Production**](/docs/next/tutorials/quickdeploy) — CI/CD setup, caching, and performance optimization
- [**Shared Strings**](/docs/next/guides/shared-strings) — Translate text in arrays, config objects, and shared data with `msg()`
1 change: 1 addition & 0 deletions docs/en-US/react/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,5 +310,6 @@ That's it — your app is now multilingual. 🎉
- [**`<T>` Component Guide**](/docs/react/guides/t) — Learn about variables, plurals, and advanced translation patterns
- [**String Translation Guide**](/docs/react/guides/strings) — Deep dive into `useGT`
- [**Variable Components**](/docs/react/guides/variables) — Handle dynamic content with `<Var>`, `<Num>`, `<Currency>`, and `<DateTime>`
- [**Pluralization**](/docs/react/api/components/plural) — Handle plural forms with the `<Plural>` component
- [**Deploying to Production**](/docs/react/tutorials/quickdeploy) — CI/CD setup, caching, and performance optimization
- [**Shared Strings**](/docs/react/guides/shared-strings) — Translate text in arrays, config objects, and shared data with `msg()`
Loading