Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: advanced footer #265

Merged
merged 5 commits into from
Oct 11, 2024
Merged

feat: advanced footer #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b44ab2c
Update global.mdx
rickyzhangca Sep 4, 2024
0c5958d
fix example
hahnbeelee Oct 10, 2024
e3238fe
Merge branch 'main' into ricky/advanced-footer
hahnbeelee Oct 10, 2024
7fdf4c0
add all social options
hahnbeelee Oct 10, 2024
ea9dc0e
ADVANCED FOOTER
hahnbeelee Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 72 additions & 4 deletions mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
60 changes: 41 additions & 19 deletions settings/global.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down