Skip to content

Commit 447205c

Browse files
Clarify custom frontmatter fields are not added to HTML head
- Fix og:sitename to og:site_name in frontmatter example - Add note to SEO metadata page that custom fields aren't supported - Add note to frontmatter page SEO section with same clarification - Link to custom JavaScript docs for analytics tracking workaround Co-Authored-By: Devin Logan <[email protected]>
1 parent 31ea230 commit 447205c

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

fern/products/docs/pages/customization/frontmatter.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ subtitle: Set titles, add meta descriptions, and more
1616
slug: frontmatter
1717
description: Use frontmatter to set the page title, subtitle, slug, meta description, its OpenGraph image, and a URL to suggest edits.
1818
keywords: frontmatter, seo, customization, metadata
19-
og:sitename: Your Company Inc.
19+
og:site_name: Your Company Inc.
2020
og:title: SEO Metadata Title
2121
---
2222
```
@@ -253,6 +253,8 @@ Currently, relative paths are _not_ supported for this field.
253253
[Use the metadata field in the `docs.yml` file](/learn/docs/configuration/site-level-settings#seo-metadata-configuration).
254254
</Note>
255255

256+
Only the documented SEO fields below are converted into HTML meta tags. Custom frontmatter fields are not added to the page head. For custom analytics tracking, see [custom JavaScript](/learn/docs/customization/custom-css-js).
257+
256258
<Markdown src="/snippets/seo-metadata-page.mdx" />
257259

258260
## Changelog tags

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,8 @@ Set default SEO metadata for your entire documentation site in [`docs.yml`](/doc
6161

6262
Configure SEO metadata in your page's [frontmatter](/docs/configuration/page-level-settings) to control how individual pages appear in search results and social media shares. These settings override site-wide settings.
6363

64+
<Info>
65+
Only the documented SEO fields below are recognized. Custom frontmatter fields are not added to the HTML head. For custom analytics tracking, use [custom JavaScript](/learn/docs/customization/custom-css-js).
66+
</Info>
67+
6468
<Markdown src="/snippets/seo-metadata-page.mdx" />

0 commit comments

Comments
 (0)