Components Footer
Footer
Configure the doc site footer — from a slim social bar to a rich multi-column 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)
On doc engine v1, with no footer configuration, pages end with a slim bar containing:
•
Social icons — built from your
github URL and socialLinks entries•
Brand row — your project name and logo
json
{
"github": "https://github.com/acme/docs",
"socialLinks": [
{ "platform": "X", "url": "https://x.com/acme" },
{ "platform": "Discord", "url": "https://discord.gg/acme" }
]
}
Note
Doc engine v2 has no slim footer: without footer.columns, a page has no site footer.
Rich Footer
Add footer.columns to render a full-bleed, multi-column footer with your logo, social icons, and grouped link lists:
json
{
"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
links array are skipped•
On doc engine v1, external URLs (starting with
http) open in a new tab automatically; on doc engine v2 they open in the same tab•
Your logo and social icons appear in a brand column to the left of the link columns. On doc engine v2 the icons are GitHub, X (
X or Twitter) and LinkedIn only, and a bottom row carries the copyright line and a Built with Syntext link•
Colors follow the active theme, including dark mode
Tip
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 (doc engine v1) or no footer (doc engine v2).