プレビューの生成

ローカルサイトプレビューを生成する方法を学習します。これにより、Braze Docs で作業がどのように見えるかを確認できます。

Prerequisites

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

プレビューの生成

ステップ 1:ブランチのチェックアウト

端末で、サイトプレビューに使用するブランチをチェックアウトします。

1
git checkout BRANCH_NAME

BRANCH_NAME を、あるブランチまたは別の人のブランチの名前に置き換えます。コマンドは次のようになります。

1
git checkout BD-2346-fixing-typo-swift

ステップ 2:ローカルサーバーを起動する

ローカルサーバを起動すると、現在のブランチ 内のファイルが、Braze Docs のローカルプレビューを構築するために使用されます。現在のブランチを使用してローカルサーバを起動するには、braze-docs ディレクトリで次のコマンドを実行します。

1
rake

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

1
2
3
4
5
6
7
8
9
== Sinatra (v3.0.4) has taken the stage on 4000 for development with backup from Puma
Puma starting in single mode...
* Puma version: 6.3.1 (ruby 3.2.2-p225) ("Mugi No Toki Itaru")
*  Min threads: 8
*  Max threads: 32
*  Environment: development
*          PID: 16158
* Listening on http://127.0.0.1:4000
...

ステップ 3:サイトプレビューを開く

デフォルトでは、サイトプレビューはlocalhost http://127.0.0.1:4000 に生成されます。サイトプレビューを開くには、Web ブラウザでリンクを開きます。

ステップ 4: ローカルサーバーを停止する

ローカルサーバーを停止するには、ターミナルを再度開き、Control + C を押します。

プレビューの更新

ほとんどの場合、braze-docs のファイルを変更すると、サイトプレビューが自動的に更新されます。この場合、ターミナルは次のようなメッセージを出力します。

1
2
3
Asset Pipeline: Processing 'javascript_asset_tag' manifest 'global'
Asset Pipeline: Saved 'global-128fd02b54e35ea79fcb21ea460fac06.js' to '/Users/alex-lee/braze-docs/_site/assets'
                    ...done in 1.940883 seconds.

ブラウザでこれらの更新を表示するには、ページを更新します。

ただし、次の場合など、サイトプレビューがnot を自動的に更新する場合があります。

• ファイル名またはディレクトリ名が変更された場合
• 新しいファイルまたはディレクトリが追加された
• _includes ディレクトリ内のファイルの内容が編集されます

これらの更新を確認するには、[ローカルサーバーを停止し、再起動する必要があります。