Components
Footer
Every Syntext doc site ships with a footer. It comes in two forms, both configured from syntext.json — no MDX required.
Slim Footer (default)
With no footer configuration, pages end with a slim bar containing:
- Social icons — built from your
githubURL andsocialLinksentries - Brand row — your project name and logo
{
"github": "https://github.com/acme/docs",
"socialLinks": [
{ "platform": "X", "url": "https://x.com/acme" },
{ "platform": "Discord", "url": "https://discord.gg/acme" }
]
}
Rich Footer
Add footer.columns to render a full-bleed, multi-column footer with your logo, social icons, and grouped link lists:
{
"footer": {
"columns": [
{
"title": "Product",
"links": [
{ "label": "Documentation", "url": "/guides/quickstart" },
{ "label": "API Reference", "url": "/api-reference/overview" }
]
},
{
"title": "Company",
"links": [
{ "label": "About", "url": "https://example.com" },
{ "label": "Blog", "url": "https://example.com/blog" }
]
}
]
}
}
Column Fields
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | No | Heading shown above the column's links |
links |
array | Yes | Links in the column |
links[].label |
string | Yes | Link text |
links[].url |
string | Yes | Internal path (/guides/quickstart) or external URL |
Behavior
- Columns with an empty
linksarray are skipped - External URLs (starting with
http) open in a new tab automatically - Your logo and social icons appear in a brand column to the left of the link columns
- Colors follow the active theme, including dark mode
Footer changes are config-only — pushing an updated syntext.json triggers a rebuild even when no page content changed.
Removing the Rich Footer
Delete the footer key (or its columns) from syntext.json to fall back to the slim footer.
Related
Was this page helpful?