Skip to content

Add localization docs #332

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

Merged
merged 1 commit into from
Nov 7, 2024
Merged

Add localization docs #332

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
61 changes: 47 additions & 14 deletions settings/global.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,18 @@ settings. Learn more about the [properties](#properties) or from an
Custom fonts. Apply globally or set different fonts for headings and the body
text.

Example:
```json
"font": {
"headings": {
"family": "Roboto"
},
"body": {
"family": "Oswald"
}
Example:

```json
"font": {
"headings": {
"family": "Roboto"
},
"body": {
"family": "Oswald"
}
```
}
```

<Expandable title="FontDetailsType">
<ResponseField name="family" type="string" required>
Expand Down Expand Up @@ -196,10 +197,7 @@ settings. Learn more about the [properties](#properties) or from an
<ResponseField name="search" type="Search">
The location options for the search bar.
<Expandable title="Search">
<ResponseField
name="location"
type={'"side" | "top"'}
>
<ResponseField name="location" type={'"side" | "top"'}>
The location of the search bar.
</ResponseField>
</Expandable>
Expand Down Expand Up @@ -282,6 +280,41 @@ settings. Learn more about the [properties](#properties) or from an
<ResponseField name="versions" type="string[]">
Array of version names. Only use this if you want to show different versions
of docs with a dropdown in the navigation bar.

Example:
<CodeGroup>

```json Default
"versions": ["v1.0", "v1.1"]
```

```json Localization
"versions": [
{
"name": "English",
"locale": "en",
},
{
"name": "Español",
"locale": "es"
}
]
```

</CodeGroup>

<Expandable title="Version">
<ResponseField name="name" type="string" required>
The version name.
</ResponseField>
<ResponseField name="locale" type="string">
The locale of the version. Supported locales are `en`, `cn`, `es`, `fr`, `jp`, `pt`, `pt-BR`.
</ResponseField>
<ResponseField name="default" type="true">
Whether the version is the default version. Handy for when you have a "latest" and "stable" version and you want to default to the stable version.
</ResponseField>
</Expandable>

</ResponseField>

<ResponseField name="anchors" type="Anchor[]">
Expand Down