メタデータは、記事内 (YAML front matter 内) に適用することも、リポジトリの docfx.json ファイル内にグローバルに適用することもできます。 既存の記事を編集する場合、メタデータを変更する必要はおそらくないでしょう。 ただし、新しい記事を追加する場合は、特定の必須メタデータ属性をファイルの YAML フロント マターに含める必要があります。
Markdown 記事の YAML front matter で適用されるメタデータの例を次に示します。
---
title: # the article title to show on the browser tab
description: # 115 - 145 character description to show in search results
author: {github-id} # the author's GitHub ID - will be auto-populated if set in settings.json
ms.author: {ms-alias} # the author's Microsoft alias (if applicable) - will be auto-populated if set in settings.json
ms.date: {@date} # the date - will be auto-populated when template is first applied
ms.topic: getting-started # the type of article
---
# Heading 1 <!-- the article title to show on the web page -->
必須メタデータ
次の表に、必須メタデータ属性を示します。 これらのどれを省略しても、ビルド中に検証エラーが発生する可能性があります。
| フィールド | 値 | なぜですか? |
|---|---|---|
author |
作成者の GitHub アカウント ID。 | コンテンツに関して質問または問題がある場合に、GitHub ID で作成者を識別します。 場合によっては、ファイルを必要とするアクティビティが GitHub オートメーションによって作成者に通知されます。 |
description |
コンテンツの概要。 75 から 300 文字。 | サイト検索で使用されます。 SEO の改善を目的として、検索エンジンの結果ページで使用される場合があります。 |
ms.author |
"@microsoft.com" を "含まない" 作成者の Microsoft エイリアス。 自分が Microsoft の従業員でない場合は、このフィールドで使用する適切な Microsoft の従業員を見つける必要があります。 | 記事の所有者を識別します。 所有者は、記事のコンテンツに関する決定と、記事のレポートおよび BI について責任があります。 |
ms.date |
MM/DD/YYYY 形式の日付です。 | 公開済みページに表示される日付です。前回、記事が大幅に編集されたか、"最新" であることが保証された日付を示します。 日付は時刻なしで入力され、0:00 として UTC タイム ゾーンで解釈されます。 ユーザーに表示される日付は、該当するタイム ゾーンに変換されます。 |
title |
ページのタイトル。 | これは、ブラウザー タブに表示されるページ タイトルです。これは SEO の最も重要なメタデータです。 |
属性では大文字と小文字が区別されます。 表示されているとおりに入力し、属性と値の間にコロンとスペースを使用します。 属性の値にコロン (:)、ハッシュ (#)、または他の特殊文字が含まれる場合は、単一引用符 (') または二重引用符 (") で値を囲む必要があります。 次に例を示します。
---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->