フロントマターは、title などのページのメタデータです。ページ先頭の --- で囲んだ YAML で書きます。
例:
---
title: Create a Cloudflare Tunnel
pcx_content_type: how-to
products:
- cloudflare-tunnel
description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.
sidebar:
order: 2
---利用できるフィールドの詳細は Nimbus のドキュメント ↗ を参照してください。
pcx_content_type があるすべてのページには、次を含めます。
| フィールド | 説明 |
|---|---|
title |
ページタイトル。プレーンテキストです。 |
pcx_content_type |
ページのコンテンツタイプ。コンテンツタイプ を参照してください。 |
description |
<meta name="description"> タグに使う 1〜2 文の要約。description の書き方 を参照してください。 |
description フィールドは、HTML の head にある <meta name="description"> タグに入ります。検索エンジン、AI クローラー、llms.txt の利用者が、ページを掲載するか引用するかを判断するときに、最も重要なメタデータフィールドです。
良い description は次の条件を満たします。
- 自己完結した 1〜2 文である（50〜160 文字を目安にする）。
- 製品名または機能名を入れる。
- そのページで読者ができること、または理解できることを述べる。
- ページから抜き出しても、単独の回答スニペットとして成立する。
「このページでは...」「...について詳しく見る」「このドキュメントでは...」のような汎用的な書き出しは使わないでください。最も価値のあるメタデータ領域を、情報を足さずに消費してしまいます。
既存の summary フィールドは、ページ上の体験には引き続き役立ちます。ただし AI と検索の用途では、description の方が優先されます。
description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.description: Set the required and optional frontmatter fields that carry a page's metadata, such as title, description, and pcx_content_type.sidebar、tags、products、difficulty、reviewed などの任意フィールドは カスタムプロパティ を参照してください。
利用できるフィールドの詳細は Nimbus のドキュメント ↗ を参照してください。