Skip to content

docs: add footer-links configuration documentation #1340

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

Merged
merged 2 commits into from
Oct 21, 2025
Merged

docs: add footer-links configuration documentation #1340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7df6729
docs: add footer-links configuration documentation
devin-ai-integration[bot] Oct 21, 2025
a8dbe43
add links between footer config section and seo metadata page
devalog Oct 21, 2025
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
72 changes: 72 additions & 0 deletions fern/products/docs/pages/customization/what-is-docs-yml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,78 @@
By default, the `rightIcon` for a `filled` button is set to `arrow-right`.
</ParamField>

## Footer links configuration

Add clickable social media and community links to your documentation site footer to improve discoverability and engagement.

<Note>
Footer links provide visual navigation to your social channels. To configure SEO metadata and social media tags at the page or site level, see [metadata configuration](/learn/docs/seo/setting-seo-metadata).

Check warning on line 274 in fern/products/docs/pages/customization/what-is-docs-yml.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'SEO' has no definition.

Raw Output:
{"message": "[FernStyles.Acronyms] 'SEO' has no definition.", "location": {"path": "fern/products/docs/pages/customization/what-is-docs-yml.mdx", "range": {"start": {"line": 274, "column": 80}}}, "severity": "INFO"}
</Note>

```yaml docs.yml
footer-links:
github: https://github.com/your-org/your-repo
slack: https://your-community.slack.com
x: https://x.com/yourhandle
twitter: https://twitter.com/yourhandle
linkedin: https://www.linkedin.com/company/your-company
youtube: https://www.youtube.com/@yourchannel
instagram: https://www.instagram.com/yourhandle
facebook: https://www.facebook.com/yourpage
discord: https://discord.gg/yourinvite
hackernews: https://news.ycombinator.com/user?id=yourusername
medium: https://medium.com/@yourhandle
website: https://yourwebsite.com
```

<ParamField path="footer-links.github" type="string" required={false} toc={true}>
URL to your GitHub repository or organization.
</ParamField>

<ParamField path="footer-links.slack" type="string" required={false} toc={true}>
URL to your Slack community or workspace.
</ParamField>

<ParamField path="footer-links.x" type="string" required={false} toc={true}>
URL to your X (formerly Twitter) profile.
</ParamField>

<ParamField path="footer-links.twitter" type="string" required={false} toc={true}>
URL to your Twitter profile. Use `footer-links.x` for the new X branding.
</ParamField>

<ParamField path="footer-links.linkedin" type="string" required={false} toc={true}>
URL to your LinkedIn company page or profile.
</ParamField>

<ParamField path="footer-links.youtube" type="string" required={false} toc={true}>
URL to your YouTube channel.
</ParamField>

<ParamField path="footer-links.instagram" type="string" required={false} toc={true}>
URL to your Instagram profile.
</ParamField>

<ParamField path="footer-links.facebook" type="string" required={false} toc={true}>
URL to your Facebook page.
</ParamField>

<ParamField path="footer-links.discord" type="string" required={false} toc={true}>
URL to your Discord server invite.
</ParamField>

<ParamField path="footer-links.hackernews" type="string" required={false} toc={true}>
URL to your Hacker News profile.
</ParamField>

<ParamField path="footer-links.medium" type="string" required={false} toc={true}>
URL to your Medium publication or profile.
</ParamField>

<ParamField path="footer-links.website" type="string" required={false} toc={true}>
URL to your main website or homepage.
</ParamField>

## Background image configuration

```yaml docs.yml
Expand Down
4 changes: 4 additions & 0 deletions fern/products/docs/pages/seo/metadata.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@

When configuring SEO metadata, ensure your titles and descriptions are unique, descriptive, and relevant to the page content. Keep descriptions between 150-160 characters for optimal display in search results.

<Note>
The metadata configurations on this page are for SEO and social tags that aren't visible to users. For visible footer links, see [footer links configuration](/learn/docs/configuration/what-is-docs-yml#footer-links-configuration).

Check warning on line 11 in fern/products/docs/pages/seo/metadata.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'SEO' has no definition.

Raw Output:
{"message": "[FernStyles.Acronyms] 'SEO' has no definition.", "location": {"path": "fern/products/docs/pages/seo/metadata.mdx", "range": {"start": {"line": 11, "column": 54}}}, "severity": "INFO"}
</Note>

## Page metadata

Set SEO properties in each page's [frontmatter](/docs/configuration/page-level-settings) to control how individual pages appear in search results and social media shares. Page-level metadata takes precedence over site-wide settings.
Expand Down