Clarify custom frontmatter fields are not added to HTML head #1894
+5
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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 <devinannlogan@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
- Create seo-custom-metadata-note.mdx snippet - Replace inline notes in metadata.mdx and frontmatter.mdx with snippet reference - Ensures consistent messaging across both pages Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -0,0 +1,3 @@ | |||
| <Info> | |||
| Only the documented SEO fields 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). | |||
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.
Contributor
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Contributor
Contributor
devalog
approved these changes
Nov 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify custom frontmatter fields are not added to HTML head
Summary
This PR addresses user feedback about whether custom frontmatter fields can be added to the HTML head tag as metadata. The documentation now explicitly clarifies that only the documented SEO fields are recognized, and provides a link to the custom JavaScript workaround for analytics tracking use cases.
Changes:
og:sitename→og:site_namein frontmatter example to match the schemaseo-custom-metadata-note.mdxfor the clarification messageReview & Testing Checklist for Human
/learn/docs/customization/custom-css-jsresolves correctly in the previewog:site_name(with underscore) is the correct field name vsog:sitename(without underscore)Notes