Skip to content

セクション

Brazeドークスでセクションを作成および順序付けする方法について説明します。個々のページを作成、変更、または削除するには、ページを参照してください。セクションの一般的な情報については、コンテンツ管理を参照してください。

Prerequisites

If you haven’t already, complete the steps for Contributing to Braze Docs.

セクションの作成

ステップ 1:ディレクトリとマークダウンファイルを作成する

関連するプライマリセクションまたはサブセクションを開き、新しいセクションのディレクトリとマークダウンファイルを作成します。

1
2
3
4
5
6

braze-docs
└── _docs
    └── PRIMARY_SECTION 
        └── SUBSECTION 
            ├── NEW_DIRECTORY 
            └── NEW_FILE.md

以下を交換します。

プレースホルダ 説明
PRIMARY_SECTION 新しいコンテンツが属するプライマリセクションの名前。詳細については、プライマリセクションを参照してください。
SUBSECTION 該当する場合は、新しいコンテンツのサブセクションの名前が属します。詳細については、サブセクションを参照してください。
NEW_DIRECTORY 新しいセクションの名前。ろう付けドックススタイルガイド に従います。すべての小文字を使用し、特殊文字を削除し、スペースをアンダースコアに置き換えます(_)。この名前はNEW_FILE と一致する必要があります。
NEW_FILE 新しいセクションの名前。Braze Docs Style Guide に従います。すべての小文字を使用し、特殊文字を削除し、スペースをアンダースコアに置き換えます(_)。この名前はNEW_DIRECTORY と一致する必要があります。

ディレクトリ構造は、次のようになります。

1
2
3
4
5
6

braze-docs
└── _docs
    └── _developer_guide 
        └── platform_wide 
            ├── getting_started 
            └── getting_started.md

ステップ 2:セクションの設定

新しいセクションを作成するときに、ランディングページの有無にかかわらず、新しいセクションを設定できます。

  • ランディングページあり:セクションで&quot のランディングページ、Getting started&quot、前提条件のリスト化、ユーザージャーニーの概要など、専用の概要が必要な場合は、この方法を使用します。
  • ランディングページなし:セクションに専用の概要が必要ない場合は、この方法を使用します。Braze Docs Style Guideに記載されているように、コンテンツは常に役立つはずです。便利なコンテンツが少ない場合は、ランディングページを追加しないでください。

新しいMarkdown ファイルを開き、以下のテンプレートを追加します。テンプレートの詳細については、テンプレートを参照してください。

```マークダウン

nav_title: NAV_TITLE article_title: LANDING_PAGE_TITLE description: SHORT_DESCRIPTION —

LANDING_PAGE_TITLE

SHORT_DESCRIPTION

HEADING

CONTENT ```

以下を交換します。

プレースホルダ 説明
NAV_TITLE ページのタイトルが左側のナビゲーションバーに表示されます。ほとんどの場合、nav_title はarticle_title に一致する必要がありますが、領域を節約するには、より短い_ を使用しますが、_ title は同じです。
LANDING_PAGE_TITLE ランディングページのタイトル。メタデータのLANDING_PAGE_TITLE の値は検索エンジンの結果に使用され、LANDING_PAGE_TITLE の値はページに表示されるタイトルに使用されます。
SHORT_DESCRIPTION ページの短い1-2 センテンスの説明。YAML のSHORT_DESCRIPTION 値は検索エンジンの結果に使用され、SHORT_DESCRIPTION 値はページに表示される説明に使用されます。
HEADING 見出し2セクションのタイトル。
CONTENT 見出し2 セクションの本文段落。

サブセクションのMarkdown ファイルを開き、以下のメタデータを追加してページのナビゲーションタイトルを設定し、ランディングページを無効にします。

```マークダウン

nav_title: NAV_TITLE config_only: true — ```

NAV_TITLE は、左側のナビゲーションバーに表示されるページのタイトルに置き換えます。ページは次のようになります。

```マークダウン

nav_title: はじめに page_order: 2 noindex: true config_only: true — ```

ステップ 3:ページを追加する

新しいディレクトリで、ページごとにマークダウンファイルを作成します。デフォルトのページレイアウトを使用するには、ステップ2 でテンプレートを使用します。ディレクトリ構造は、次のようになります。

1
2
3
4
5
6
7
8

braze-docs
└── _docs
    └── _developer_guide 
        └── platform_wide 
            ├── getting_started 
            │    ├── integrating_the_sdk.md 
            │    └── setting_up_push_notifications.md
            └── getting_started.md

各ページへのコンテンツの追加が完了したら、セクションの順序付けに進みます。

セクションの注文

セクションを注文するには、そのセクションのいずれかのMarkdown ファイルを開き、YAML の前面にあるpage_order キーを検索します。

```マークダウン

page_order: — ```

page_order キーは、左側のナビゲーションバーのセクションのページの相対的な順序を表し、負でない任意の番号(0、20、5.5 など) に設定できます。つまり、カレントディレクトリ内の各Markdown ファイルのpage_order を知る必要がありますが、他のディレクトリ(サブディレクトリを含む) を知る必要はありません。

カレントディレクトリ内の各Markdown ファイルのpage_order キーを任意の負でない番号に設定します。次の例では、page_order が2 に設定されています。

```マークダウン

nav_title: B項 page_order: 2 —

B項上陸ページ

```

出力は次のようになります。

The left-side navigation on Braze Docs, with the 'Section B' landing page listed third.

  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!