メタデータ
これらは、ページのYAML フロントマターに追加できるメタデータキーです。詳細は、Content Managementを参照してください。
Markdown ファイルにメタデータを追加するには、Jekyll のフロントマター構文をファイルの先頭に追加する必要があります。
```markdown
METADATA_KEY:METADATA_VALUE —
Brazeドークスの使用開始
Braze Docs またはdocs-as-code を初めて使用する場合は、チュートリアルから始めてください。 ```
以下を交換します。
| プレースホルダ | 説明 |
|---|---|
METADATA_KEY |
サポートされているメタデータ型を表すキー。次のセクションのメタデータキー で置き換えます。 |
METADATA_VALUE |
メタデータキーに割り当てられた値。次のセクションで、メタデータキーのサポートされる値を確認します。 |
必須キー
記事タイトル
article_title キーは、オンライン検索結果のページタイトルとエンドユーザーのブラウザタブを設定するために使用されます。このキーは、任意のstring 値を受け入れます。命名規則については、ろう付けドックススタイルガイドを参照してください。
```markdown
article_title: Brazeドークスの使用開始 — ```
説明
description キーは、オンライン検索結果のページ記述を設定するために使用されます。このキーは、二重引用符で囲まれた150 文字未満のstring 値を受け入れます。
```markdown
description: “Braze Docs を初めて使用する場合は、このステップバイステップのチュートリアルから始めてください。” — ```
ナビゲーションタイトル
nav_title キーは、Braze Docs の左側のナビゲーションバーのページタイトルを設定するために使用します。このキーでは、30 文字未満のstring を使用できます。hiddenキーがtrueに設定されている場合、nav_titleは不要です。
```markdown
nav_title: はじめに — ```
オプションキー
エンゲージメントツール
tool キーは、ページに関連するエンゲージメントツールを設定するために使用されます。このキーは、以下のstring 値の1 つ以上をリストとして受け入れます。
dashboarddocscanvascampaignscurrentslocationmediareportssegmentstemplates
```markdown
tool: - 電流 セグメント — ```
ナビゲーションからページを非表示にする
hidden キーは、Braze Docs の左側のナビゲーションからページを非表示にするために使用します。このキーはブール値true またはfalse を受け入れます。
```markdown
hidden: 真 — ```
検索からページを隠す
noindex キーは、ページを内部および外部の検索結果(Braze Docs やGoogle Search など) から隠すために使用します。このキーはブール値true またはfalse を受け入れます。
```markdown
noindex: true — ```
目次を隠す
hide_toc キーは、ページ右側のページ内目次(TOC) を非表示にするために使用されます。このキーはブール値true またはfalse を受け入れます。
```markdown
hide_toc: 真 — ```
目次から見出しを隠す
toc_headers キーは、ページ右側のページ内目次(TOC) から同じレベルのすべての見出しを非表示にするために使用されます。このキーでは、次の文字列値を使用できます。
h1h2h3h4
toc_headers 割り当てられた値に一致するすべての見出しを非表示にします。特定の見出しを目次から非表示にするために使用することはできません。
```markdown
toc_headers: h2 — ```
メッセージングチャネル
channel キーは、ページの関連するメッセージングチャネルを設定するために使用されます。このキーは、以下のstring 値の1 つ以上をリストとして受け入れます。
content cardsemailin-app messagesnews feedpushsmswebhooks
```markdown
チャネル: メール ニュースフィード — ```
ナビゲーションのみ
config_only キーは、ページのコンテンツを左側のナビゲーションバーで非表示にせずに非表示にするために使用します。ランディングページのないセクションを作成する時に使用します。このキーは、ブール値true またはfalse を受け入れます。
```markdown
config_only: true — ```
デフォルトURL を上書きする
permalink キーは、hidden キーと一緒に使用して、Braze Docs のページのデフォルトURL をオーバーライドします。permalink に割り当てられた値は、リダイレクトの前にhttps://www.braze.com/docs が付加されます。このキーは、以下の要件を満たす任意のstring 値を受け入れます。
- 文字は小文字
- ワードはアンダースコアで区切られます(
_)。 - “Directories”はスラッシュで区切られます(
/) - その他の特殊文字はすべて削除されます
```markdown
hidden: 真 permalink: /support_contact/docs_team/ — ```
ページレイアウト
layout キーは、ページのレイアウトを設定するために使用されます。layout が設定されていない場合、default レイアウトが使用されます。このキーは、次のstring 値のいずれかを受け入れます。
api_pagedev_guidefeatured_videofeaturedglossary_pageblank_configredirect
各値の詳細については、ページレイアウトを参照してください。
```markdown
page_layout: glossary_page — ```
ページ順
page_order キーは、左側のナビゲーションバーの order sections に使用します。このキーは、負でない任意の数値(0、20、または5.5 など) を受け入れます。
```markdown
page_order: 35.6 — ```
ページタイプ
page_type キーは、ページの書式を設定するために使用します。このキーは、次のstring 値のいずれかを受け入れます。
glossarysolutionreferencetutoriallandingpartnerupdate
各値の詳細については、ページタイプを参照してください。
```markdown
page_type: チュートリアル — ```
プラットフォーム
platform キーは、ページの関連プラットフォームを設定するために使用されます。このキーは、1 つ以上のBraze SDKs をリスト内のstring 値として受け入れます。
```markdown
プラットフォーム: iOS Web Android — ```
GitHub でこのページを編集