Skip to content

Add info on keywords in frontmatter (Docs) #576

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 1 commit into from
Aug 23, 2025
Merged

Add info on keywords in frontmatter (Docs) #576

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion fern/products/docs/pages/customization/frontmatter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ title: Customize content using frontmatter
subtitle: Set titles, add meta descriptions, and more
slug: frontmatter
description: Use frontmatter to set the page title, subtitle, slug, meta description, its OpenGraph image, and a URL to suggest edits.
keywords: frontmatter, seo, customization, metadata
og:sitename: Your Company Inc.
og:title: SEO Metadata Title
---
Expand Down Expand Up @@ -254,7 +255,8 @@ When configuring SEO metadata, ensure your titles and descriptions are unique, d
```mdx
---
title: PlantStore API Quick Start
headline: "Gett Started with PlantStore API | Developer Documentation"
headline: "Get Started with PlantStore API | Developer Documentation"
keywords: plants, garden, nursery
canonical-url: https://docs.plantstore.dev/welcome
og:site_name: PlantStore Developer Documentation
og:title: "PlantStore API Quick Start Guide"
Expand All @@ -279,6 +281,13 @@ nofollow: false
Overrides the canonical URL for this page. Must be a full URL including the protocol (i.e. `https://buildwithfern.com/learn/docs/content/frontmatter`)
</ParamField>

<ParamField path="keywords" type="string" required={false}>
Comma-separated string of keywords relevant to the page content (i.e. `plants, garden, nursery`). These keywords help search engines understand the page topic and contributes to search rankings. Use specific, relevant terms that users might search for when looking for the page's content.

This field accepts only comma-separated strings, not bracketed arrays.

</ParamField>

### OpenGraph Properties
<ParamField path="og:site_name" type="string" required={false}>
The name of your website as it should appear when your content is shared.
Expand Down