diff --git a/settings/global.mdx b/settings/global.mdx
index 7ef092cfa..28000711b 100644
--- a/settings/global.mdx
+++ b/settings/global.mdx
@@ -33,6 +33,7 @@ settings. Learn more about the [properties](#properties) or from an
Where clicking on the logo links you to
+
@@ -71,6 +72,7 @@ settings. Learn more about the [properties](#properties) or from an
+
@@ -82,7 +84,11 @@ settings. Learn more about the [properties](#properties) or from an
[Prism](https://starter-prism.mintlify.app)
-
+
The global layout style of the documentation.
@@ -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"
}
- ```
+}
+```
@@ -143,6 +149,7 @@ settings. Learn more about the [properties](#properties) or from an
The font format. Required if using a custom font source (`url`).
+
@@ -174,6 +181,7 @@ settings. Learn more about the [properties](#properties) or from an
```
+
@@ -243,6 +251,7 @@ settings. Learn more about the [properties](#properties) or from an
The type of [Fontawesome](https://fontawesome.com/icons) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin
+
@@ -257,6 +266,7 @@ settings. Learn more about the [properties](#properties) or from an
The url once you click on the button. Example: `https://mintlify.com/contact`
+
@@ -283,6 +293,7 @@ settings. Learn more about the [properties](#properties) or from an
Whether to display the arrow
+
@@ -290,16 +301,21 @@ settings. Learn more about the [properties](#properties) or from an
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).
+
+ Localization applies to the UI and fixed assets in the docs, such as "was this
+ page helpful".
+
- Example:
+For more information, please refer to our
+[versioning documentation](/settings/versioning).
+
+Example:
```json Default
@@ -318,6 +334,7 @@ settings. Learn more about the [properties](#properties) or from an
}
]
```
+
@@ -332,15 +349,24 @@ settings. Learn more about the [properties](#properties) or from an
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.
+
An array of the anchors, includes the icon, color, and url.
-
+{" "}
+
-
+{" "}
+
@@ -374,6 +400,7 @@ settings. Learn more about the [properties](#properties) or from an
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
+
@@ -393,26 +420,27 @@ settings. Learn more about the [properties](#properties) or from an
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
+
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"
+ }
+]
+```
@@ -427,6 +455,7 @@ settings. Learn more about the [properties](#properties) or from an
Pass `true` if you want to hide the tab until you directly link someone to docs inside it.
+
@@ -434,27 +463,27 @@ settings. Learn more about the [properties](#properties) or from an
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" }
+ ]
+ }
+ ]
+}
+```
@@ -468,6 +497,7 @@ settings. Learn more about the [properties](#properties) or from an
Example: `https://x.com/mintlify`
+
@@ -478,6 +508,7 @@ settings. Learn more about the [properties](#properties) or from an
The link items in the column. External urls that starts with `https://` or `http://` will be opened in new tab.
+
@@ -496,6 +527,7 @@ settings. Learn more about the [properties](#properties) or from an
Enables a button to allow users to raise an issue about the documentation
+
@@ -591,6 +623,7 @@ settings. Learn more about the [properties](#properties) or from an
+
@@ -598,7 +631,7 @@ settings. Learn more about the [properties](#properties) or from an
A string or an array of strings of URL(s) or relative path(s) pointing to your
OpenAPI file.
- Examples:
+Examples:
```json Absolute
@@ -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"]
```
+
@@ -628,6 +662,7 @@ settings. Learn more about the [properties](#properties) or from an
Enables Frontchat widget on docs site. The value should be your Frontchat App ID.
+
@@ -641,16 +676,16 @@ settings. Learn more about the [properties](#properties) or from an
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"
+ }
+]
+```
@@ -664,6 +699,7 @@ settings. Learn more about the [properties](#properties) or from an
Example: `/destination`
+
@@ -672,13 +708,13 @@ settings. Learn more about the [properties](#properties) or from an
Settings for Search Engine Optimization.
- Example:
+Example:
- ```json
- "seo": {
- "indexHiddenPages": true
- }
- ```
+```json
+"seo": {
+ "indexHiddenPages": true
+}
+```
@@ -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/).
\ No newline at end of file
+[Custom Scripts](https://mintlify.com/docs/advanced/custom/).