Skip to content

Commit e8d0bf1

Browse files
dino475hahnbeelee
andauthored
Dean making sure customers understand what localization does (#360)
* Dean making sure customers understand what localization does * update copy --------- Co-authored-by: Hahnbee Lee <[email protected]>
1 parent f33ba6f commit e8d0bf1

File tree

1 file changed

+108
-72
lines changed

1 file changed

+108
-72
lines changed

settings/global.mdx

Lines changed: 108 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ settings. Learn more about the [properties](#properties) or from an
3333
<ResponseField name="href" type="string" default="/">
3434
Where clicking on the logo links you to
3535
</ResponseField>
36+
3637
</Expandable>
3738
</ResponseField>
3839

@@ -71,6 +72,7 @@ settings. Learn more about the [properties](#properties) or from an
7172
</ResponseField>
7273
</Expandable>
7374
</ResponseField>
75+
7476
</Expandable>
7577
</ResponseField>
7678

@@ -82,7 +84,11 @@ settings. Learn more about the [properties](#properties) or from an
8284
[Prism](https://starter-prism.mintlify.app)
8385
</ResponseField>
8486

85-
<ResponseField name="layout" type={'"topnav" | "sidenav" | "solidSidenav"'} default="topnav">
87+
<ResponseField
88+
name="layout"
89+
type={'"topnav" | "sidenav" | "solidSidenav"'}
90+
default="topnav"
91+
>
8692
The global layout style of the documentation.
8793
</ResponseField>
8894

@@ -109,18 +115,18 @@ settings. Learn more about the [properties](#properties) or from an
109115
Custom fonts. Apply globally or set different fonts for headings and the body
110116
text.
111117

112-
Example:
118+
Example:
113119

114-
```json
115-
"font": {
116-
"headings": {
117-
"family": "Roboto"
118-
},
119-
"body": {
120-
"family": "Oswald"
121-
}
120+
```json
121+
"font": {
122+
"headings": {
123+
"family": "Roboto"
124+
},
125+
"body": {
126+
"family": "Oswald"
122127
}
123-
```
128+
}
129+
```
124130

125131
<Expandable title="FontDetailsType">
126132
<ResponseField name="family" type="string" required>
@@ -143,6 +149,7 @@ settings. Learn more about the [properties](#properties) or from an
143149
<ResponseField name="format" type="'woff' | 'woff2'">
144150
The font format. Required if using a custom font source (`url`).
145151
</ResponseField>
152+
146153
</Expandable>
147154
</ResponseField>
148155

@@ -174,6 +181,7 @@ settings. Learn more about the [properties](#properties) or from an
174181
```
175182
</CodeGroup>
176183
</ResponseField>
184+
177185
</Expandable>
178186
</ResponseField>
179187

@@ -243,6 +251,7 @@ settings. Learn more about the [properties](#properties) or from an
243251
<ResponseField name="iconType" type="string">
244252
The type of [Fontawesome](https://fontawesome.com/icons) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin
245253
</ResponseField>
254+
246255
</Expandable>
247256
</ResponseField>
248257

@@ -257,6 +266,7 @@ settings. Learn more about the [properties](#properties) or from an
257266
<ResponseField name="url" type="string">
258267
The url once you click on the button. Example: `https://mintlify.com/contact`
259268
</ResponseField>
269+
260270
</Expandable>
261271
</ResponseField>
262272

@@ -283,23 +293,29 @@ settings. Learn more about the [properties](#properties) or from an
283293
<ResponseField name="arrow" type="boolean">
284294
Whether to display the arrow
285295
</ResponseField>
296+
286297
</Expandable>
287298
</ResponseField>
288299

289300
<ResponseField name="versions" type="string[]">
290301
Array of version names. Only use this if you want to show different versions
291302
of docs with a dropdown in the navigation bar.
292303

293-
Versions can be leveraged for localization. You can store translated content
294-
under a version, and once you specify the `locale` any fixed text in Mintlify,
295-
such as 'Was this page helpful?', will automatically be translated based on the
296-
locale. We currently support localization in English, Chinese, Spanish, French,
297-
Japanese, and Portuguese.
304+
Versions can be leveraged for localization. You can store translated content
305+
under a version, and once you specify the `locale` any fixed text in Mintlify,
306+
such as 'Was this page helpful?', will automatically be translated based on the
307+
locale. We currently support localization in English, Chinese, Spanish, French,
308+
Japanese, and Portuguese.
298309

299-
For more information, please refer to our
300-
[versioning documentation](/settings/versioning).
310+
<Info>
311+
Localization applies to the UI and fixed assets in the docs, such as "was this
312+
page helpful".
313+
</Info>
301314

302-
Example:
315+
For more information, please refer to our
316+
[versioning documentation](/settings/versioning).
317+
318+
Example:
303319

304320
<CodeGroup>
305321
```json Default
@@ -318,6 +334,7 @@ settings. Learn more about the [properties](#properties) or from an
318334
}
319335
]
320336
```
337+
321338
</CodeGroup>
322339

323340
<Expandable title="Version">
@@ -332,15 +349,24 @@ settings. Learn more about the [properties](#properties) or from an
332349
<ResponseField name="default" type="true">
333350
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.
334351
</ResponseField>
352+
335353
</Expandable>
336354
</ResponseField>
337355

338356
<ResponseField name="anchors" type="Anchor[]">
339357
An array of the anchors, includes the icon, color, and url.
340358

341-
<img className="block h-32 dark:hidden" src="https://mintlify-assets.b-cdn.net/anchors-light.png" />
359+
{" "}
360+
<img
361+
className="block h-32 dark:hidden"
362+
src="https://mintlify-assets.b-cdn.net/anchors-light.png"
363+
/>
342364

343-
<img className="hidden h-32 dark:block" src="https://mintlify-assets.b-cdn.net/anchors-dark.png" />
365+
{" "}
366+
<img
367+
className="hidden h-32 dark:block"
368+
src="https://mintlify-assets.b-cdn.net/anchors-dark.png"
369+
/>
344370

345371
<Expandable title="Anchor">
346372
<ResponseField name="name" type="string" required>
@@ -374,6 +400,7 @@ settings. Learn more about the [properties](#properties) or from an
374400
<ResponseField name="iconType" default="duotone" type="string">
375401
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
376402
</ResponseField>
403+
377404
</Expandable>
378405
</ResponseField>
379406

@@ -393,26 +420,27 @@ settings. Learn more about the [properties](#properties) or from an
393420
<ResponseField name="iconType" default="duotone" type="string">
394421
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
395422
</ResponseField>
423+
396424
</Expandable>
397425
</ResponseField>
398426

399427
<ResponseField name="tabs" type="Tabs[]">
400428
An array of navigational tabs.
401429

402-
Example:
430+
Example:
403431

404-
```json
405-
"tabs": [
406-
{
407-
"name": "Writing Content",
408-
"url": "content"
409-
},
410-
{
411-
"name": "API References",
412-
"url": "api-playground"
413-
}
414-
]
415-
```
432+
```json
433+
"tabs": [
434+
{
435+
"name": "Writing Content",
436+
"url": "content"
437+
},
438+
{
439+
"name": "API References",
440+
"url": "api-playground"
441+
}
442+
]
443+
```
416444

417445
<Expandable title="Tabs">
418446
<ResponseField name="name" type="string">
@@ -427,34 +455,35 @@ settings. Learn more about the [properties](#properties) or from an
427455
<ResponseField name="isDefaultHidden" type="boolean" default={false}>
428456
Pass `true` if you want to hide the tab until you directly link someone to docs inside it.
429457
</ResponseField>
458+
430459
</Expandable>
431460
</ResponseField>
432461

433462
<ResponseField name="footer" type="{ socials?: FooterSocials, links?: FooterLinksColumn[] }">
434463
An object to configure the footer with socials and links.
435464
Example:
436465

437-
```json
438-
"footer": {
439-
"socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" },
440-
"links": [
441-
{
442-
"title": "Column 1",
443-
"links": [
444-
{ "label": "Column 1 Link 1", "url": "https://mintlify.com" },
445-
{ "label": "Column 1 Link 2", "url": "https://mintlify.com" }
446-
]
447-
},
448-
{
449-
"title": "Column 2",
450-
"links": [
451-
{ "label": "Column 2 Link 1", "url": "https://mintlify.com" },
452-
{ "label": "Column 2 Link 2", "url": "https://mintlify.com" }
453-
]
454-
}
455-
]
456-
}
457-
```
466+
```json
467+
"footer": {
468+
"socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" },
469+
"links": [
470+
{
471+
"title": "Column 1",
472+
"links": [
473+
{ "label": "Column 1 Link 1", "url": "https://mintlify.com" },
474+
{ "label": "Column 1 Link 2", "url": "https://mintlify.com" }
475+
]
476+
},
477+
{
478+
"title": "Column 2",
479+
"links": [
480+
{ "label": "Column 2 Link 1", "url": "https://mintlify.com" },
481+
{ "label": "Column 2 Link 2", "url": "https://mintlify.com" }
482+
]
483+
}
484+
]
485+
}
486+
```
458487

459488
<Expandable title="FooterSocials">
460489
<ResponseField name="[key]" type="string">
@@ -468,6 +497,7 @@ settings. Learn more about the [properties](#properties) or from an
468497

469498
Example: `https://x.com/mintlify`
470499
</ResponseField>
500+
471501
</Expandable>
472502

473503
<Expandable title="FooterLinksColumn">
@@ -478,6 +508,7 @@ settings. Learn more about the [properties](#properties) or from an
478508
<ResponseField name="links" type="{ label: string, url: string }[]">
479509
The link items in the column. External urls that starts with `https://` or `http://` will be opened in new tab.
480510
</ResponseField>
511+
481512
</Expandable>
482513
</ResponseField>
483514

@@ -496,6 +527,7 @@ settings. Learn more about the [properties](#properties) or from an
496527
<ResponseField name="raiseIssue" type="boolean" default={false}>
497528
Enables a button to allow users to raise an issue about the documentation
498529
</ResponseField>
530+
499531
</Expandable>
500532
</ResponseField>
501533

@@ -591,14 +623,15 @@ settings. Learn more about the [properties](#properties) or from an
591623
</ResponseField>
592624
</Expandable>
593625
</ResponseField>
626+
594627
</Expandable>
595628
</ResponseField>
596629

597630
<ResponseField name="openapi" type="string | string[]">
598631
A string or an array of strings of URL(s) or relative path(s) pointing to your
599632
OpenAPI file.
600633

601-
Examples:
634+
Examples:
602635

603636
<CodeGroup>
604637
```json Absolute
@@ -612,6 +645,7 @@ settings. Learn more about the [properties](#properties) or from an
612645
```json Multiple
613646
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
614647
```
648+
615649
</CodeGroup>
616650
</ResponseField>
617651

@@ -628,6 +662,7 @@ settings. Learn more about the [properties](#properties) or from an
628662
<ResponseField name="frontchat" type="string">
629663
Enables Frontchat widget on docs site. The value should be your Frontchat App ID.
630664
</ResponseField>
665+
631666
</Expandable>
632667
</ResponseField>
633668

@@ -641,16 +676,16 @@ settings. Learn more about the [properties](#properties) or from an
641676
<ResponseField name="redirects" type="Redirect[]">
642677
An array of paths you want to configure to permanently redirect to another path
643678

644-
Example:
679+
Example:
645680

646-
```json
647-
"redirects": [
648-
{
649-
"source": "/source/path",
650-
"destination": "/destination/path"
651-
}
652-
]
653-
```
681+
```json
682+
"redirects": [
683+
{
684+
"source": "/source/path",
685+
"destination": "/destination/path"
686+
}
687+
]
688+
```
654689

655690
<Expandable title="Redirect">
656691
<ResponseField name="source" type="string">
@@ -664,6 +699,7 @@ settings. Learn more about the [properties](#properties) or from an
664699

665700
Example: `/destination`
666701
</ResponseField>
702+
667703
</Expandable>
668704
</ResponseField>
669705

@@ -672,13 +708,13 @@ settings. Learn more about the [properties](#properties) or from an
672708
<ResponseField name="seo" type="SEO">
673709
Settings for Search Engine Optimization.
674710

675-
Example:
711+
Example:
676712

677-
```json
678-
"seo": {
679-
"indexHiddenPages": true
680-
}
681-
```
713+
```json
714+
"seo": {
715+
"indexHiddenPages": true
716+
}
717+
```
682718

683719
<Expandable title="Redirect">
684720
<ResponseField name="indexHiddenPages" type="boolean" default="false">
@@ -763,4 +799,4 @@ Click on the following dropdown to view a sample configuration file
763799
## More Customization
764800

765801
Learn more about how to further customize your docs with custom CSS and JS in
766-
[Custom Scripts](https://mintlify.com/docs/advanced/custom/).
802+
[Custom Scripts](https://mintlify.com/docs/advanced/custom/).

0 commit comments

Comments
 (0)