From b44ab2ce7625c2f0331139f053b3ecb9dc18293c Mon Sep 17 00:00:00 2001
From: Ricky Zhang <16908811+rickyzhangca@users.noreply.github.com>
Date: Wed, 4 Sep 2024 19:50:57 -0400
Subject: [PATCH 1/4] Update global.mdx
---
settings/global.mdx | 60 +++++++++++++++++++++++++++++++--------------
1 file changed, 41 insertions(+), 19 deletions(-)
diff --git a/settings/global.mdx b/settings/global.mdx
index 5afe50117..3e4f13609 100644
--- a/settings/global.mdx
+++ b/settings/global.mdx
@@ -295,28 +295,50 @@ Example:
-
- An object of social media accounts where the key:property pair represents the social media platform and the account url.
-
- Example:
+
+An object to configure the footer with socials and links.
+Example:
```json
-{
- "x": "https://x.com/mintlify",
- "website": "https://mintlify.com"
+"footer": {
+ "socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" },
+ "links": [
+ {
+ "title": "Column 1",
+ "links": [
+ { "name": "Column 1 Link 1", "url": "https://mintlify.com" },
+ { "name": "Column 1 Link 2", "url": "https://mintlify.com" }
+ ]
+ },
+ {
+ "title": "Column 2",
+ "links": [
+ { "name": "Column 2 Link 1", "url": "https://mintlify.com" },
+ { "name": "Column 2 Link 2", "url": "https://mintlify.com" }
+ ]
+ }
+ ]
}
```
-
-
- One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
-
- Example: `x`
-
-
- The URL to the social platform.
-
- Example: `https://x.com/mintlify`
-
-
+
+
+ One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
+
+ Example: `x`
+
+
+ The URL to the social platform.
+
+ Example: `https://x.com/mintlify`
+
+
+
+
+ Title of the column
+
+
+ The link items in the column. External urls that starts with `https://` or `http://` will be opened in new tab.
+
+
From 0c5958d38b6aa69d8f7636ad5b7a0ecca1c84779 Mon Sep 17 00:00:00 2001
From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
Date: Wed, 9 Oct 2024 17:32:04 -0700
Subject: [PATCH 2/4] fix example
---
settings/global.mdx | 44 ++++++++++++++++++++++++++++----------------
1 file changed, 28 insertions(+), 16 deletions(-)
diff --git a/settings/global.mdx b/settings/global.mdx
index 3e4f13609..eca8b301d 100644
--- a/settings/global.mdx
+++ b/settings/global.mdx
@@ -66,15 +66,18 @@ settings. Learn more about the [properties](#properties) or from an
- A preset theme configuration that changes the look and feel of the project. A theme is a set of default styling configurations.
-
- Examples:
+ A preset theme configuration that changes the look and feel of the project. A
+ theme is a set of default styling configurations. Examples:
[Venus](https://starter-venus.mintlify.app),
[Quill](https://starter-quill.mintlify.app),
[Prism](https://starter-prism.mintlify.app)
-
+
The global layout style of the documentation.
@@ -119,13 +122,18 @@ settings. Learn more about the [properties](#properties) or from an
+
Customize the styling of components within the sidebar.
-
+
The styling of the navigation item.
@@ -134,7 +142,11 @@ settings. Learn more about the [properties](#properties) or from an
Styling configurations for the topbar.
-
+
The styling of the navigation item.
@@ -188,13 +200,13 @@ settings. Learn more about the [properties](#properties) or from an
-
- Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
+
+ Link shows a button. GitHub shows the repo information at the url provided
+ including the number of GitHub stars.
- If type is a link: What the button links to.
-
- If type is a github: Link to the repository to load GitHub information from.
+ If type is a link: What the button links to. If type is a github: Link to
+ the repository to load GitHub information from.
Text inside the button. Only required if type is a link.
@@ -305,15 +317,15 @@ Example:
{
"title": "Column 1",
"links": [
- { "name": "Column 1 Link 1", "url": "https://mintlify.com" },
- { "name": "Column 1 Link 2", "url": "https://mintlify.com" }
+ { "label": "Column 1 Link 1", "url": "https://mintlify.com" },
+ { "label": "Column 1 Link 2", "url": "https://mintlify.com" }
]
},
{
"title": "Column 2",
"links": [
- { "name": "Column 2 Link 1", "url": "https://mintlify.com" },
- { "name": "Column 2 Link 2", "url": "https://mintlify.com" }
+ { "label": "Column 2 Link 1", "url": "https://mintlify.com" },
+ { "label": "Column 2 Link 2", "url": "https://mintlify.com" }
]
}
]
@@ -325,7 +337,7 @@ Example:
Example: `x`
-
+
The URL to the social platform.
Example: `https://x.com/mintlify`
From 7fdf4c0106dcf913c09157252c67ea98d6c6b04b Mon Sep 17 00:00:00 2001
From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
Date: Thu, 10 Oct 2024 16:49:31 -0700
Subject: [PATCH 3/4] add all social options
---
settings/global.mdx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/settings/global.mdx b/settings/global.mdx
index 9a7937a77..3ce100a1f 100644
--- a/settings/global.mdx
+++ b/settings/global.mdx
@@ -361,7 +361,7 @@ Example:
```
- One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
+ One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`, `medium`, `telegram`, `twitter`
Example: `x`
From ea9dc0ebdadd14bf24c4444655207da82f04707b Mon Sep 17 00:00:00 2001
From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
Date: Thu, 10 Oct 2024 17:01:45 -0700
Subject: [PATCH 4/4] ADVANCED FOOTER
---
mint.json | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 72 insertions(+), 4 deletions(-)
diff --git a/mint.json b/mint.json
index edd49b756..691e2521c 100644
--- a/mint.json
+++ b/mint.json
@@ -213,10 +213,78 @@
]
}
],
- "footerSocials": {
- "github": "https://github.com/mintlify",
- "slack": "https://mintlify.com/community",
- "x": "https://x.com/mintlify"
+ "footer": {
+ "socials": {
+ "x": "https://x.com/mintlify",
+ "linkedin": "https://www.linkedin.com/company/mintlify",
+ "github": "https://github.com/mintlify",
+ "slack": "https://mintlify.com/community"
+ },
+ "links": [
+ {
+ "title": "Resources",
+ "links": [
+ {
+ "label": "Customers",
+ "url": "https://mintlify.com/customers"
+ },
+ {
+ "label": "Enterprise",
+ "url": "https://mintlify.com/enterprise"
+ },
+ {
+ "label": "Request Preview",
+ "url": "https://mintlify.com/preview"
+ },
+ {
+ "label": "Integrations",
+ "url": "https://mintlify.com/docs/integrations/analytics/overview"
+ },
+ {
+ "label": "Templates",
+ "url": "https://github.com/mintlify/themes"
+ },
+ {
+ "label": "Wall of Love",
+ "url": "https://mintlify.com/love"
+ }
+ ]
+ },
+ {
+ "title": "Company",
+ "links": [
+ {
+ "label": "Careers",
+ "url": "https://mintlify.com/careers"
+ },
+ {
+ "label": "Blog",
+ "url": "https://mintlify.com/blog"
+ },
+ {
+ "label": "Public Roadmap",
+ "url": "https://feedback.mintlify.com/roadmap"
+ },
+ {
+ "label": "Security",
+ "url": "https://mintlify.com/security/responsible-disclosure"
+ }
+ ]
+ },
+ {
+ "title": "Legal",
+ "links": [
+ {
+ "label": "Privacy Policy",
+ "url": "https://mintlify.com/legal/privacy"
+ },
+ {
+ "label": "Terms of Service",
+ "url": "https://mintlify.com/legal/terms"
+ }
+ ]
+ }
+ ]
},
"analytics": {
"ga4": {