feat: advanced footer (#265)

* Update global.mdx * fix example * add all social options * ADVANCED FOOTER --------- Co-authored-by: Hahnbee Lee <[email protected]>
mintlify · Oct 11, 2024 · b5c4835 · b5c4835
1 parent 120e2e8
commit b5c4835
Show file tree

Hide file tree

Showing 2 changed files with 113 additions and 23 deletions.
diff --git 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": {

diff --git a/settings/global.mdx b/settings/global.mdx
@@ -335,28 +335,50 @@ Example:
   </Expandable>
 </ResponseField>
 
-<ResponseField name="footerSocials" type="FooterSocials">
-  An object of social media accounts where the key:property pair represents the social media platform and the account url.
-
-  Example: 
+<ResponseField name="footer" type="{ socials?: FooterSocials, links?: FooterLinksColumn[] }">
+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": [
+        { "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">
-    One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
-
-    Example: `x`
-    </ResponseField>
-    <ResponseField name="property" type="string">
-    The URL to the social platform.
-
-    Example: `https://x.com/mintlify`
-    </ResponseField>
-  </Expandable>
+<Expandable title="FooterSocials">
+  <ResponseField name="[key]" type="string">
+  One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`, `medium`, `telegram`, `twitter`
+
+  Example: `x`
+  </ResponseField>
+  <ResponseField name="value" type="string">
+  The URL to the social platform.
+
+  Example: `https://x.com/mintlify`
+  </ResponseField>
+</Expandable>
+<Expandable title="FooterLinksColumn">
+  <ResponseField name="title" type="string">
+  Title of the column
+  </ResponseField>
+  <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>
 
 <ResponseField name="feedback" type="Feedback">