Skip to content

Commit b5c4835

Browse files
feat: advanced footer (#265)
* Update global.mdx * fix example * add all social options * ADVANCED FOOTER --------- Co-authored-by: Hahnbee Lee <[email protected]>
1 parent 120e2e8 commit b5c4835

File tree

2 files changed

+113
-23
lines changed

2 files changed

+113
-23
lines changed

mint.json

Lines changed: 72 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -213,10 +213,78 @@
213213
]
214214
}
215215
],
216-
"footerSocials": {
217-
"github": "https://github.com/mintlify",
218-
"slack": "https://mintlify.com/community",
219-
"x": "https://x.com/mintlify"
216+
"footer": {
217+
"socials": {
218+
"x": "https://x.com/mintlify",
219+
"linkedin": "https://www.linkedin.com/company/mintlify",
220+
"github": "https://github.com/mintlify",
221+
"slack": "https://mintlify.com/community"
222+
},
223+
"links": [
224+
{
225+
"title": "Resources",
226+
"links": [
227+
{
228+
"label": "Customers",
229+
"url": "https://mintlify.com/customers"
230+
},
231+
{
232+
"label": "Enterprise",
233+
"url": "https://mintlify.com/enterprise"
234+
},
235+
{
236+
"label": "Request Preview",
237+
"url": "https://mintlify.com/preview"
238+
},
239+
{
240+
"label": "Integrations",
241+
"url": "https://mintlify.com/docs/integrations/analytics/overview"
242+
},
243+
{
244+
"label": "Templates",
245+
"url": "https://github.com/mintlify/themes"
246+
},
247+
{
248+
"label": "Wall of Love",
249+
"url": "https://mintlify.com/love"
250+
}
251+
]
252+
},
253+
{
254+
"title": "Company",
255+
"links": [
256+
{
257+
"label": "Careers",
258+
"url": "https://mintlify.com/careers"
259+
},
260+
{
261+
"label": "Blog",
262+
"url": "https://mintlify.com/blog"
263+
},
264+
{
265+
"label": "Public Roadmap",
266+
"url": "https://feedback.mintlify.com/roadmap"
267+
},
268+
{
269+
"label": "Security",
270+
"url": "https://mintlify.com/security/responsible-disclosure"
271+
}
272+
]
273+
},
274+
{
275+
"title": "Legal",
276+
"links": [
277+
{
278+
"label": "Privacy Policy",
279+
"url": "https://mintlify.com/legal/privacy"
280+
},
281+
{
282+
"label": "Terms of Service",
283+
"url": "https://mintlify.com/legal/terms"
284+
}
285+
]
286+
}
287+
]
220288
},
221289
"analytics": {
222290
"ga4": {

settings/global.mdx

Lines changed: 41 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -335,28 +335,50 @@ Example:
335335
</Expandable>
336336
</ResponseField>
337337

338-
<ResponseField name="footerSocials" type="FooterSocials">
339-
An object of social media accounts where the key:property pair represents the social media platform and the account url.
340-
341-
Example:
338+
<ResponseField name="footer" type="{ socials?: FooterSocials, links?: FooterLinksColumn[] }">
339+
An object to configure the footer with socials and links.
340+
Example:
342341
```json
343-
{
344-
"x": "https://x.com/mintlify",
345-
"website": "https://mintlify.com"
342+
"footer": {
343+
"socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" },
344+
"links": [
345+
{
346+
"title": "Column 1",
347+
"links": [
348+
{ "label": "Column 1 Link 1", "url": "https://mintlify.com" },
349+
{ "label": "Column 1 Link 2", "url": "https://mintlify.com" }
350+
]
351+
},
352+
{
353+
"title": "Column 2",
354+
"links": [
355+
{ "label": "Column 2 Link 1", "url": "https://mintlify.com" },
356+
{ "label": "Column 2 Link 2", "url": "https://mintlify.com" }
357+
]
358+
}
359+
]
346360
}
347361
```
348-
<Expandable title="FooterSocials">
349-
<ResponseField name="[key]" type="string">
350-
One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
351-
352-
Example: `x`
353-
</ResponseField>
354-
<ResponseField name="property" type="string">
355-
The URL to the social platform.
356-
357-
Example: `https://x.com/mintlify`
358-
</ResponseField>
359-
</Expandable>
362+
<Expandable title="FooterSocials">
363+
<ResponseField name="[key]" type="string">
364+
One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`, `medium`, `telegram`, `twitter`
365+
366+
Example: `x`
367+
</ResponseField>
368+
<ResponseField name="value" type="string">
369+
The URL to the social platform.
370+
371+
Example: `https://x.com/mintlify`
372+
</ResponseField>
373+
</Expandable>
374+
<Expandable title="FooterLinksColumn">
375+
<ResponseField name="title" type="string">
376+
Title of the column
377+
</ResponseField>
378+
<ResponseField name="links" type="{ label: string, url: string }[]">
379+
The link items in the column. External urls that starts with `https://` or `http://` will be opened in new tab.
380+
</ResponseField>
381+
</Expandable>
360382
</ResponseField>
361383

362384
<ResponseField name="feedback" type="Feedback">

0 commit comments

Comments
 (0)