Skip to content

Commit e148e03

Browse files
devin-ai-integration[bot]dannysheridandevalog
authored
docs: add footer-links configuration documentation (#1340)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: [email protected] <[email protected]> Co-authored-by: Devin Logan <[email protected]>
1 parent dae77ba commit e148e03

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

fern/products/docs/pages/customization/what-is-docs-yml.mdx

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,78 @@ navbar-links:
266266
By default, the `rightIcon` for a `filled` button is set to `arrow-right`.
267267
</ParamField>
268268

269+
## Footer links configuration
270+
271+
Add clickable social media and community links to your documentation site footer to improve discoverability and engagement.
272+
273+
<Note>
274+
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).
275+
</Note>
276+
277+
```yaml docs.yml
278+
footer-links:
279+
github: https://github.com/your-org/your-repo
280+
slack: https://your-community.slack.com
281+
x: https://x.com/yourhandle
282+
twitter: https://twitter.com/yourhandle
283+
linkedin: https://www.linkedin.com/company/your-company
284+
youtube: https://www.youtube.com/@yourchannel
285+
instagram: https://www.instagram.com/yourhandle
286+
facebook: https://www.facebook.com/yourpage
287+
discord: https://discord.gg/yourinvite
288+
hackernews: https://news.ycombinator.com/user?id=yourusername
289+
medium: https://medium.com/@yourhandle
290+
website: https://yourwebsite.com
291+
```
292+
293+
<ParamField path="footer-links.github" type="string" required={false} toc={true}>
294+
URL to your GitHub repository or organization.
295+
</ParamField>
296+
297+
<ParamField path="footer-links.slack" type="string" required={false} toc={true}>
298+
URL to your Slack community or workspace.
299+
</ParamField>
300+
301+
<ParamField path="footer-links.x" type="string" required={false} toc={true}>
302+
URL to your X (formerly Twitter) profile.
303+
</ParamField>
304+
305+
<ParamField path="footer-links.twitter" type="string" required={false} toc={true}>
306+
URL to your Twitter profile. Use `footer-links.x` for the new X branding.
307+
</ParamField>
308+
309+
<ParamField path="footer-links.linkedin" type="string" required={false} toc={true}>
310+
URL to your LinkedIn company page or profile.
311+
</ParamField>
312+
313+
<ParamField path="footer-links.youtube" type="string" required={false} toc={true}>
314+
URL to your YouTube channel.
315+
</ParamField>
316+
317+
<ParamField path="footer-links.instagram" type="string" required={false} toc={true}>
318+
URL to your Instagram profile.
319+
</ParamField>
320+
321+
<ParamField path="footer-links.facebook" type="string" required={false} toc={true}>
322+
URL to your Facebook page.
323+
</ParamField>
324+
325+
<ParamField path="footer-links.discord" type="string" required={false} toc={true}>
326+
URL to your Discord server invite.
327+
</ParamField>
328+
329+
<ParamField path="footer-links.hackernews" type="string" required={false} toc={true}>
330+
URL to your Hacker News profile.
331+
</ParamField>
332+
333+
<ParamField path="footer-links.medium" type="string" required={false} toc={true}>
334+
URL to your Medium publication or profile.
335+
</ParamField>
336+
337+
<ParamField path="footer-links.website" type="string" required={false} toc={true}>
338+
URL to your main website or homepage.
339+
</ParamField>
340+
269341
## Background image configuration
270342

271343
```yaml docs.yml

fern/products/docs/pages/seo/metadata.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Optimize your documentation's search visibility and social media presence by con
77

88
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.
99

10+
<Note>
11+
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).
12+
</Note>
13+
1014
## Page metadata
1115

1216
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.

0 commit comments

Comments
 (0)