diff --git a/fern/products/docs/pages/customization/what-is-docs-yml.mdx b/fern/products/docs/pages/customization/what-is-docs-yml.mdx index b8aa48473..107bb0944 100644 --- a/fern/products/docs/pages/customization/what-is-docs-yml.mdx +++ b/fern/products/docs/pages/customization/what-is-docs-yml.mdx @@ -266,6 +266,78 @@ navbar-links: By default, the `rightIcon` for a `filled` button is set to `arrow-right`. +## Footer links configuration + +Add clickable social media and community links to your documentation site footer to improve discoverability and engagement. + + + 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). + + +```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 +``` + + + URL to your GitHub repository or organization. + + + + URL to your Slack community or workspace. + + + + URL to your X (formerly Twitter) profile. + + + + URL to your Twitter profile. Use `footer-links.x` for the new X branding. + + + + URL to your LinkedIn company page or profile. + + + + URL to your YouTube channel. + + + + URL to your Instagram profile. + + + + URL to your Facebook page. + + + + URL to your Discord server invite. + + + + URL to your Hacker News profile. + + + + URL to your Medium publication or profile. + + + + URL to your main website or homepage. + + ## Background image configuration ```yaml docs.yml diff --git a/fern/products/docs/pages/seo/metadata.mdx b/fern/products/docs/pages/seo/metadata.mdx index 5e84eedcc..463a0edc0 100644 --- a/fern/products/docs/pages/seo/metadata.mdx +++ b/fern/products/docs/pages/seo/metadata.mdx @@ -7,6 +7,10 @@ Optimize your documentation's search visibility and social media presence by con 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. + + 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). + + ## 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.