Skip to content

Commit a57559d

Browse files
authored
Add info on keywords in frontmatter (Docs) (#576)
1 parent 61eb5c7 commit a57559d

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ title: Customize content using frontmatter
1515
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.
18+
keywords: frontmatter, seo, customization, metadata
1819
og:sitename: Your Company Inc.
1920
og:title: SEO Metadata Title
2021
---
@@ -254,7 +255,8 @@ When configuring SEO metadata, ensure your titles and descriptions are unique, d
254255
```mdx
255256
---
256257
title: PlantStore API Quick Start
257-
headline: "Gett Started with PlantStore API | Developer Documentation"
258+
headline: "Get Started with PlantStore API | Developer Documentation"
259+
keywords: plants, garden, nursery
258260
canonical-url: https://docs.plantstore.dev/welcome
259261
og:site_name: PlantStore Developer Documentation
260262
og:title: "PlantStore API Quick Start Guide"
@@ -279,6 +281,13 @@ nofollow: false
279281
Overrides the canonical URL for this page. Must be a full URL including the protocol (i.e. `https://buildwithfern.com/learn/docs/content/frontmatter`)
280282
</ParamField>
281283

284+
<ParamField path="keywords" type="string" required={false}>
285+
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.
286+
287+
This field accepts only comma-separated strings, not bracketed arrays.
288+
289+
</ParamField>
290+
282291
### OpenGraph Properties
283292
<ParamField path="og:site_name" type="string" required={false}>
284293
The name of your website as it should appear when your content is shared.

0 commit comments

Comments
 (0)