メタデータ

これらは、ページのYAML フロントマターに追加できるメタデータキーです。詳細は、Content Managementを参照してください。

Markdown ファイルにメタデータを追加するには、Jekyll のフロントマター構文をファイルの先頭に追加する必要があります。

```マークダウン

METADATA_KEY:METADATA_VALUE —

Brazeドークスの使用開始

Braze Docs またはdocs-as-code を初めて使用する場合は、チュートリアルから始めてください。 ```

以下を交換します。

プレースホルダ	説明
`METADATA_KEY`	サポートされているメタデータ型を表すキー。次のセクションのメタデータキーで置き換えます。
`METADATA_VALUE`	メタデータキーに割り当てられた値。次のセクションで、メタデータキーのサポートされる値を確認します。

必須キー

記事タイトル

article_title キーは、オンライン検索結果のページタイトルとエンドユーザーのブラウザタブを設定するために使用されます。このキーは、任意のstring 値を受け入れます。命名規則については、ろう付けドックススタイルガイドを参照してください。

usage example

```マークダウン

article_title: Brazeドークスの使用開始 — ```

説明

description キーは、オンライン検索結果のページ記述を設定するために使用されます。このキーは、二重引用符で囲まれた150 文字未満のstring 値を受け入れます。

usage example

```マークダウン

description: “Braze Docs を初めて使用する場合は、このステップバイステップのチュートリアルから始めてください。” — ```

ナビゲーションタイトル

nav_title キーは、Braze Docs の左側のナビゲーションバーのページタイトルを設定するために使用します。このキーでは、30 文字未満のstring を使用できます。hiddenキーがtrueに設定されている場合、nav_titleは不要です。

usage example

```マークダウン

nav_title: はじめに — ```

オプションキー

エンゲージメントツール

tool キーは、ページに関連するエンゲージメントツールを設定するために使用されます。このキーは、以下のstring 値の1 つ以上をリストとして受け入れます。

dashboard
docs
canvas
campaigns
currents
location
media
reports
segments
templates

usage example

```マークダウン

tool: - 電流セグメント — ```

ナビゲーションからページを非表示にする

hidden キーは、Braze Docs の左側のナビゲーションからページを非表示にするために使用します。このキーはブール値true またはfalse を受け入れます。

usage example

```マークダウン

hidden: 真 — ```

検索からページを隠す

noindex キーは、ページを内部および外部の検索結果(Braze Docs やGoogle Search など) から隠すために使用します。このキーはブール値true またはfalse を受け入れます。

usage example

```マークダウン

noindex: true — ```

目次を隠す

hide_toc キーは、ページ右側のページ内目次(TOC) を非表示にするために使用されます。このキーはブール値true またはfalse を受け入れます。

usage example

```マークダウン

hide_toc: 真 — ```

目次から見出しを隠す

toc_headers キーは、ページ右側のページ内目次(TOC) から同じレベルのすべての見出しを非表示にするために使用されます。このキーでは、次の文字列値を使用できます。

h1
h2
h3
h4

toc_headers 割り当てられた値に一致するすべての見出しを非表示にします。特定の見出しを目次から非表示にするために使用することはできません。

usage example

```マークダウン

toc_headers: h2 — ```

メッセージングチャネル

channel キーは、ページの関連するメッセージングチャネルを設定するために使用されます。このキーは、以下のstring 値の1 つ以上をリストとして受け入れます。

content cards
email
in-app messages
news feed
push
sms
webhooks

usage example

```マークダウン

チャネル: メールニュースフィード — ```

ナビゲーションのみ

config_only キーは、ページのコンテンツを左側のナビゲーションバーで非表示にせずに非表示にするために使用します。ランディングページのないセクションを作成する時に使用します。このキーは、ブール値true またはfalse を受け入れます。

usage example

```マークダウン

config_only: true — ```

デフォルトURL を上書きする

permalink キーは、hidden キーと一緒に使用して、Braze Docs のページのデフォルトURL をオーバーライドします。permalink に割り当てられた値は、リダイレクトの前にhttps://www.braze.com/docs が付加されます。このキーは、以下の要件を満たす任意のstring 値を受け入れます。