serveコマンド

serveコマンドは、HTTPで本を配信してプレビューするために使います。既定の配信先はlocalhost:3000です。

mdbook serve

serveコマンドは、本のsrcディレクトリの変更を監視し、変更のたびに本を再ビルドして、クライアントの表示を更新します。SUMMARY.mdにまだ記載されている削除済みファイルも再作成します。クライアント側の表示更新には、WebSocket接続を使います。

注： serveコマンドは、本のHTML出力をテストするためのものであり、ウェブサイト向けの本格的なHTTPサーバーとしては想定されていません。

ディレクトリを指定する

serveコマンドは、現在の作業ディレクトリの代わりに本のルートとして使うディレクトリを、引数で指定できます。

mdbook serve path/to/book

サーバーのオプション

serveのホスト名は既定でlocalhost、ポートは既定で3000です。どちらもコマンドラインで指定できます。

mdbook serve path/to/book -p 8000 -n 127.0.0.1 

--open

--open（-o）フラグを使うと、mdbookはサーバーの起動後に本を既定のウェブブラウザーで開きます。

--dest-dir

本の出力ディレクトリは、--dest-dir（-d）オプションで変更できます。相対パスは現在のディレクトリを基準に解釈されます。指定しない場合は、book.tomlのbuild.build-dirキーの値、または./bookを使います。

--watcher

ファイルの変更を検出するために、複数のバックエンドを利用できます。

• poll（既定）— 毎秒ファイルシステムを走査して、ファイルの変更を確認します。
• native — OSに組み込まれた機能を使って、ファイル変更の通知を受け取ります。継続的な処理負荷が小さくなる場合がありますが、poll方式の監視ほど確実でない場合があります。詳しくは、次のIssueを参照してください： #383 #1441 #1707 #2035 #2102

除外パターンを指定する

serveコマンドは、本のルートディレクトリにある.gitignoreに記載されたファイルの変更では、ビルドを自動実行しません。.gitignoreには、gitignoreの文書で説明されているファイルパターンを指定できます。エディターが作成する一時ファイルを無視する場合などに便利です。

注： 本のルートディレクトリにある.gitignoreだけを使います。グローバルな$HOME/.gitignoreや、親ディレクトリの.gitignoreは使いません。