Skip to content

Commit 82506a6

Browse files
authored
Add localization docs (#332)
1 parent 24f1616 commit 82506a6

File tree

1 file changed

+47
-14
lines changed

1 file changed

+47
-14
lines changed

settings/global.mdx

Lines changed: 47 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,18 @@ settings. Learn more about the [properties](#properties) or from an
103103
Custom fonts. Apply globally or set different fonts for headings and the body
104104
text.
105105

106-
Example:
107-
```json
108-
"font": {
109-
"headings": {
110-
"family": "Roboto"
111-
},
112-
"body": {
113-
"family": "Oswald"
114-
}
106+
Example:
107+
108+
```json
109+
"font": {
110+
"headings": {
111+
"family": "Roboto"
112+
},
113+
"body": {
114+
"family": "Oswald"
115115
}
116-
```
116+
}
117+
```
117118

118119
<Expandable title="FontDetailsType">
119120
<ResponseField name="family" type="string" required>
@@ -196,10 +197,7 @@ settings. Learn more about the [properties](#properties) or from an
196197
<ResponseField name="search" type="Search">
197198
The location options for the search bar.
198199
<Expandable title="Search">
199-
<ResponseField
200-
name="location"
201-
type={'"side" | "top"'}
202-
>
200+
<ResponseField name="location" type={'"side" | "top"'}>
203201
The location of the search bar.
204202
</ResponseField>
205203
</Expandable>
@@ -282,6 +280,41 @@ settings. Learn more about the [properties](#properties) or from an
282280
<ResponseField name="versions" type="string[]">
283281
Array of version names. Only use this if you want to show different versions
284282
of docs with a dropdown in the navigation bar.
283+
284+
Example:
285+
<CodeGroup>
286+
287+
```json Default
288+
"versions": ["v1.0", "v1.1"]
289+
```
290+
291+
```json Localization
292+
"versions": [
293+
{
294+
"name": "English",
295+
"locale": "en",
296+
},
297+
{
298+
"name": "Español",
299+
"locale": "es"
300+
}
301+
]
302+
```
303+
304+
</CodeGroup>
305+
306+
<Expandable title="Version">
307+
<ResponseField name="name" type="string" required>
308+
The version name.
309+
</ResponseField>
310+
<ResponseField name="locale" type="string">
311+
The locale of the version. Supported locales are `en`, `cn`, `es`, `fr`, `jp`, `pt`, `pt-BR`.
312+
</ResponseField>
313+
<ResponseField name="default" type="true">
314+
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.
315+
</ResponseField>
316+
</Expandable>
317+
285318
</ResponseField>
286319

287320
<ResponseField name="anchors" type="Anchor[]">

0 commit comments

Comments
 (0)