MkDocsがListenするアドレス・ポートを指定する

MkDocsでコンテンツを開発する際、mkdocs serveを実行することでライブサーバを起動できます。このライブサーバはデフォルトで「localhost:8000」をListenします。今回はMkDocsがListenするアドレス・ポートを変更する方法をメモしておきます。

コマンドラインからアドレスとポートを指定する

Command Line Interfaceに書かれていますが、オプションを指定することで明示的にアドレスとポートを指定することができます。

mkdocs serve --dev-addr localhost:8123

設定ファイルでアドレスとポートを指定する

設定ファイルでアドレスとポートを指定するには、mkdocs.ymlで以下のように指定します。

mkdocs.yml

dev_addr: "127.0.0.1:8001"
site_name: My Docs

これでmkdocs serveを実行するだけで、指定したアドレスとポートでMkDocsが起動します。

% mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Documentation built in 0.03 seconds
INFO    -  [00:07:04] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO    -  [00:07:04] Serving on http://127.0.0.1:8001/

注意点：「CLIのオプション」と「設定ファイルの項目名」は異なる

「CLIのオプション」と「設定ファイルの項目名」はよく似ているのですが、「単語間の記号」が以下のように異なります。間違って指定するとエラーになってしまう為、注意が必要です。

設定方法	設定	備考
CLI	--dev-addr	「dev」と「addr」の間は「ハイフン」
設定ファイル(mkdocs.yml)	dev_addr	「dev」と「addr」の間は「アンダースコア」