Skip to content

Dean making sure customers understand what localization does #360

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 4 commits into from
Dec 12, 2024
Merged

Dean making sure customers understand what localization does #360

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7ba8283
Dean making sure customers understand what localization does
dino475 Nov 15, 2024
78ac9a2
Merge branch 'main' into dean-clarifying-localization
hahnbeelee Dec 12, 2024
a96322d
update copy
hahnbeelee Dec 12, 2024
464e91b
Merge branch 'main' of https://github.com/mintlify/docs into dean-cla…
hahnbeelee Dec 12, 2024
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
180 changes: 108 additions & 72 deletions settings/global.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ settings. Learn more about the [properties](#properties) or from an
<ResponseField name="href" type="string" default="/">
Where clicking on the logo links you to
</ResponseField>

</Expandable>
</ResponseField>

Expand Down Expand Up @@ -71,6 +72,7 @@ settings. Learn more about the [properties](#properties) or from an
</ResponseField>
</Expandable>
</ResponseField>

</Expandable>
</ResponseField>

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

<ResponseField name="layout" type={'"topnav" | "sidenav" | "solidSidenav"'} default="topnav">
<ResponseField
name="layout"
type={'"topnav" | "sidenav" | "solidSidenav"'}
default="topnav"
>
The global layout style of the documentation.
</ResponseField>

Expand All @@ -109,18 +115,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:
Example:

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

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

</Expandable>
</ResponseField>

Expand Down Expand Up @@ -174,6 +181,7 @@ settings. Learn more about the [properties](#properties) or from an
```
</CodeGroup>
</ResponseField>

</Expandable>
</ResponseField>

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

</Expandable>
</ResponseField>

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

</Expandable>
</ResponseField>

Expand All @@ -283,23 +293,29 @@ settings. Learn more about the [properties](#properties) or from an
<ResponseField name="arrow" type="boolean">
Whether to display the arrow
</ResponseField>

</Expandable>
</ResponseField>

<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.

Versions can be leveraged for localization. You can store translated content
under a version, and once you specify the `locale` any fixed text in Mintlify,
such as 'Was this page helpful?', will automatically be translated based on the
locale. We currently support localization in English, Chinese, Spanish, French,
Japanese, and Portuguese.
Versions can be leveraged for localization. You can store translated content
under a version, and once you specify the `locale` any fixed text in Mintlify,
such as 'Was this page helpful?', will automatically be translated based on the
locale. We currently support localization in English, Chinese, Spanish, French,
Japanese, and Portuguese.

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

Example:
For more information, please refer to our
[versioning documentation](/settings/versioning).

Example:

<CodeGroup>
```json Default
Expand All @@ -318,6 +334,7 @@ settings. Learn more about the [properties](#properties) or from an
}
]
```

</CodeGroup>

<Expandable title="Version">
Expand All @@ -332,15 +349,24 @@ settings. Learn more about the [properties](#properties) or from an
<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[]">
An array of the anchors, includes the icon, color, and url.

<img className="block h-32 dark:hidden" src="https://mintlify-assets.b-cdn.net/anchors-light.png" />
{" "}
<img
className="block h-32 dark:hidden"
src="https://mintlify-assets.b-cdn.net/anchors-light.png"
/>

<img className="hidden h-32 dark:block" src="https://mintlify-assets.b-cdn.net/anchors-dark.png" />
{" "}
<img
className="hidden h-32 dark:block"
src="https://mintlify-assets.b-cdn.net/anchors-dark.png"
/>

<Expandable title="Anchor">
<ResponseField name="name" type="string" required>
Expand Down Expand Up @@ -374,6 +400,7 @@ settings. Learn more about the [properties](#properties) or from an
<ResponseField name="iconType" default="duotone" type="string">
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
</ResponseField>

</Expandable>
</ResponseField>

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

</Expandable>
</ResponseField>

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

Example:
Example:

```json
"tabs": [
{
"name": "Writing Content",
"url": "content"
},
{
"name": "API References",
"url": "api-playground"
}
]
```
```json
"tabs": [
{
"name": "Writing Content",
"url": "content"
},
{
"name": "API References",
"url": "api-playground"
}
]
```

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

</Expandable>
</ResponseField>

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

```json
"footer": {
"socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" },
"links": [
{
"title": "Column 1",
"links": [
{ "label": "Column 1 Link 1", "url": "https://mintlify.com" },
{ "label": "Column 1 Link 2", "url": "https://mintlify.com" }
]
},
{
"title": "Column 2",
"links": [
{ "label": "Column 2 Link 1", "url": "https://mintlify.com" },
{ "label": "Column 2 Link 2", "url": "https://mintlify.com" }
]
}
]
}
```
```json
"footer": {
"socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" },
"links": [
{
"title": "Column 1",
"links": [
{ "label": "Column 1 Link 1", "url": "https://mintlify.com" },
{ "label": "Column 1 Link 2", "url": "https://mintlify.com" }
]
},
{
"title": "Column 2",
"links": [
{ "label": "Column 2 Link 1", "url": "https://mintlify.com" },
{ "label": "Column 2 Link 2", "url": "https://mintlify.com" }
]
}
]
}
```

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

Example: `https://x.com/mintlify`
</ResponseField>

</Expandable>

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

</Expandable>
</ResponseField>

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

</Expandable>
</ResponseField>

Expand Down Expand Up @@ -591,14 +623,15 @@ settings. Learn more about the [properties](#properties) or from an
</ResponseField>
</Expandable>
</ResponseField>

</Expandable>
</ResponseField>

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

Examples:
Examples:

<CodeGroup>
```json Absolute
Expand All @@ -612,6 +645,7 @@ settings. Learn more about the [properties](#properties) or from an
```json Multiple
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
```

</CodeGroup>
</ResponseField>

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

</Expandable>
</ResponseField>

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

Example:
Example:

```json
"redirects": [
{
"source": "/source/path",
"destination": "/destination/path"
}
]
```
```json
"redirects": [
{
"source": "/source/path",
"destination": "/destination/path"
}
]
```

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

Example: `/destination`
</ResponseField>

</Expandable>
</ResponseField>

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

Example:
Example:

```json
"seo": {
"indexHiddenPages": true
}
```
```json
"seo": {
"indexHiddenPages": true
}
```

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

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