From c3eb597e8b5ec6d3a5ec8ecdb2c465c622867a64 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Tue, 14 Jan 2025 00:59:23 +0000
Subject: [PATCH 1/2] Documentation edits made through Mintlify web editor
---
settings/global.mdx | 199 ++++++++++++++++++++------------------------
settings/seo.mdx | 59 ++++++++-----
2 files changed, 128 insertions(+), 130 deletions(-)
diff --git a/settings/global.mdx b/settings/global.mdx
index 350cb3c18..65ce0f274 100644
--- a/settings/global.mdx
+++ b/settings/global.mdx
@@ -21,6 +21,12 @@ settings. Learn more about the [properties](#properties) or from an
and where the logo links to. SVG format is recommended. It does not pixelate
and the file size is generally smaller.
+
+ whats poppin
+
+
+
+
Path to the logo in light mode. For example: `/path/to/logo.svg`
@@ -33,7 +39,6 @@ settings. Learn more about the [properties](#properties) or from an
Where clicking on the logo links you to
-
@@ -72,7 +77,6 @@ settings. Learn more about the [properties](#properties) or from an
-
@@ -84,11 +88,7 @@ settings. Learn more about the [properties](#properties) or from an
[Prism](https://starter-prism.mintlify.app)
-
+
The global layout style of the documentation.
@@ -115,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"
+ }
}
-}
-```
+ ```
@@ -149,7 +149,6 @@ Example:
The font format. Required if using a custom font source (`url`).
-
@@ -181,7 +180,6 @@ Example:
```
-
@@ -251,7 +249,6 @@ Example:
The type of [Fontawesome](https://fontawesome.com/icons) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin
-
@@ -266,7 +263,6 @@ Example:
The url once you click on the button. Example: `https://mintlify.com/contact`
-
@@ -293,7 +289,6 @@ Example:
Whether to display the arrow
-
@@ -301,21 +296,21 @@ Example:
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.
-
- Localization auto-translates the UI and fixed assets in the docs, such as "Was
- this page helpful?". You must translate the content of the pages yourself.
-
+
+ Localization applies to the UI and fixed assets in the docs, such as "was this
+ page helpful".
+
-For more information, please refer to our
-[versioning & localization documentation](/settings/versioning).
+ For more information, please refer to our
+ [versioning documentation](/settings/versioning).
-Example:
+ Example:
```json Default
@@ -334,7 +329,6 @@ Example:
}
]
```
-
@@ -349,26 +343,19 @@ Example:
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.
-{" "}
+ {" "}
-
+
-{" "}
+ {" "}
-
+
@@ -402,7 +389,6 @@ Example:
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
-
@@ -422,27 +408,26 @@ Example:
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"
+ }
+ ]
+ ```
@@ -457,7 +442,6 @@ Example:
Pass `true` if you want to hide the tab until you directly link someone to docs inside it.
-
@@ -465,27 +449,27 @@ Example:
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" }
+ ]
+ }
+ ]
+ }
+ ```
@@ -499,7 +483,6 @@ Example:
Example: `https://x.com/mintlify`
-
@@ -510,7 +493,6 @@ Example:
The link items in the column. External urls that starts with `https://` or `http://` will be opened in new tab.
-
@@ -523,17 +505,16 @@ Example:
- Enables a button to allow users to suggest edits via pull requests for public repositories.
+ Enables a button to allow users to suggest edits via pull requests for public repositories.
-
- If your docs repo is private, `suggestEdit` will not work.
-
+
+ If your docs repo is private, `suggestEdit` will not work.
+
Enables a button to allow users to raise an issue about the documentation
-
@@ -629,7 +610,6 @@ Example:
-
@@ -637,7 +617,7 @@ Example:
A string or an array of strings of URL(s) or relative path(s) pointing to your
OpenAPI file.
-Examples:
+ Examples:
```json Absolute
@@ -651,7 +631,6 @@ Examples:
```json Multiple
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
```
-
@@ -668,7 +647,6 @@ Examples:
Enables Frontchat widget on docs site. The value should be your Frontchat App ID.
-
@@ -682,16 +660,16 @@ Examples:
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"
+ }
+ ]
+ ```
@@ -705,7 +683,6 @@ Example:
Example: `/destination`
-
@@ -714,13 +691,13 @@ Example:
Settings for Search Engine Optimization.
-Example:
+ Example:
-```json
-"seo": {
- "indexHiddenPages": true
-}
-```
+ ```json
+ "seo": {
+ "indexHiddenPages": true
+ }
+ ```
@@ -805,4 +782,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/).
\ No newline at end of file
diff --git a/settings/seo.mdx b/settings/seo.mdx
index cc54b7f5a..22755f304 100644
--- a/settings/seo.mdx
+++ b/settings/seo.mdx
@@ -5,24 +5,37 @@ icon: 'magnifying-glass'
---
+ * og:site\_name
-- og:site_name
-- og:title
-- og:description
-- og:url
-- og:image
-- og:locale
-- og:logo
-- article:publisher
-- twitter:title
-- twitter:description
-- twitter:url
-- twitter:image
-- twitter:site
-- og:image:width
-- og:image:height
-- robots
+ * og:title
+ * og:description
+
+ * og:url
+
+ * og:image
+
+ * og:locale
+
+ * og:logo
+
+ * article:publisher
+
+ * twitter:title
+
+ * twitter:description
+
+ * twitter:url
+
+ * twitter:image
+
+ * twitter:site
+
+ * og:image:width
+
+ * og:image:height
+
+ * robots
## Default meta tags
@@ -47,9 +60,7 @@ title: 'Your Example Page Title'
```
-
-Meta tags with colons need to be typed with quotes around them when you put them in the page metadata.
-
+ Meta tags with colons need to be typed with quotes around them when you put them in the page metadata.
## Sitemaps
@@ -65,9 +76,19 @@ Only pages included in your `mint.json` are included by default. To include hidd
```
## Disabling indexing
+
If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](/page) of your page:
+
```
---
noindex: true
---
+```
+
+You can also specify `noindex` globally using this code in the mint.json:
+
+```json
+"metadata": {
+ "robots": "noindex"
+}
```
\ No newline at end of file
From 5f29240d16fea9523d07fa611707fecfcd6ded15 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Tue, 14 Jan 2025 01:00:11 +0000
Subject: [PATCH 2/2] Documentation edits made through Mintlify web editor