コマンドラインインターフェース

mkdocs

MkDocs - Markdownによるプロジェクトドキュメント。

使用方法

mkdocs [OPTIONS] COMMAND [ARGS]...

オプション

名前	タイプ	説明	デフォルト
-V, --version	ブール値	バージョンを表示して終了します。	False
-q, --quiet	ブール値	警告を非表示にします。	False
-v, --verbose	ブール値	詳細出力を有効にします。	False
--color / --no-color	ブール値	出力の色と折り返しを強制的に有効または無効にします。デフォルトは自動検出です。	なし
--help	ブール値	このメッセージを表示して終了します。	False

サブコマンド

• build: MkDocsドキュメントをビルドします。
• get-deps: mkdocs.ymlのプラグインから推測された必要なPyPIパッケージを表示します。
• gh-deploy: ドキュメントをGitHub Pagesにデプロイします。
• new: 新しいMkDocsプロジェクトを作成します。
• serve: 組み込みの開発サーバーを実行します。

mkdocs build

MkDocsドキュメントをビルドします。

使用方法

mkdocs build [OPTIONS]

オプション

名前	タイプ	説明	デフォルト
-c, --clean / --dirty	ブール値	ビルド前にsite_dirから古いファイルを削除します（デフォルト）。	True
-f, --config-file	ファイル名	特定のMkDocs設定を指定します。ファイル名、または標準入力から読み込む場合は'-'を指定できます。	なし
-s, --strict / --no-strict	ブール値	厳格モードを有効にします。これにより、MkDocsは警告が発生するとビルドを中止します。	なし
-t, --theme	選択肢 (mkdocs | readthedocs)	ドキュメントをビルドする際に使用するテーマ。	なし
--use-directory-urls / --no-directory-urls	ブール値	ページをビルドする際にディレクトリURLを使用します（デフォルト）。	なし
-d, --site-dir	パス	ドキュメントビルドの結果を出力するディレクトリ。	なし
-q, --quiet	ブール値	警告を非表示にします。	False
-v, --verbose	ブール値	詳細出力を有効にします。	False
--help	ブール値	このメッセージを表示して終了します。	False

mkdocs get-deps

mkdocs.ymlのプラグインから推測された必要なPyPIパッケージを表示します。

使用方法

mkdocs get-deps [OPTIONS]

オプション

名前	タイプ	説明	デフォルト
-v, --verbose	ブール値	詳細出力を有効にします。	False
-f, --config-file	ファイル名	特定のMkDocs設定を指定します。ファイル名、または標準入力から読み込む場合は'-'を指定できます。	なし
-p, --projects-file	テキスト	すべての既知のMkDocs関連プロジェクトを宣言するレジストリファイルのURLまたはローカルパス。	https://raw.githubusercontent.com/mkdocs/catalog/main/projects.yaml
--help	ブール値	このメッセージを表示して終了します。	False

mkdocs gh-deploy

ドキュメントをGitHub Pagesにデプロイします。

使用方法

mkdocs gh-deploy [OPTIONS]

オプション

名前	タイプ	説明	デフォルト
-c, --clean / --dirty	ブール値	ビルド前にsite_dirから古いファイルを削除します（デフォルト）。	True
-m, --message	テキスト	GitHub Pagesのリモートブランチにコミットする際に使用するコミットメッセージ。コミット{sha}とMkDocs{version}を展開できます。	なし
-b, --remote-branch	テキスト	GitHub Pagesにコミットするリモートブランチ。設定で指定された値を上書きします。	なし
-r, --remote-name	テキスト	GitHub Pagesにコミットするリモート名。設定で指定された値を上書きします。	なし
--force	ブール値	リポジトリへのプッシュを強制します。	False
--no-history	ブール値	Gitの履歴全体を新しいコミット1つに置き換えます。	False
--ignore-version	ブール値	古いバージョンのMkDocsでビルドがデプロイされていないことのチェックを無視します。	False
--shell	ブール値	Gitの呼び出し時にシェルを使用します。	False
-f, --config-file	ファイル名	特定のMkDocs設定を指定します。ファイル名、または標準入力から読み込む場合は'-'を指定できます。	なし
-s, --strict / --no-strict	ブール値	厳格モードを有効にします。これにより、MkDocsは警告が発生するとビルドを中止します。	なし
-t, --theme	選択肢 (mkdocs | readthedocs)	ドキュメントをビルドする際に使用するテーマ。	なし
--use-directory-urls / --no-directory-urls	ブール値	ページをビルドする際にディレクトリURLを使用します（デフォルト）。	なし
-d, --site-dir	パス	ドキュメントビルドの結果を出力するディレクトリ。	なし
-q, --quiet	ブール値	警告を非表示にします。	False
-v, --verbose	ブール値	詳細出力を有効にします。	False
--help	ブール値	このメッセージを表示して終了します。	False

mkdocs new

新しいMkDocsプロジェクトを作成します。

使用方法

mkdocs new [OPTIONS] PROJECT_DIRECTORY

オプション

名前	タイプ	説明	デフォルト
-q, --quiet	ブール値	警告を非表示にします。	False
-v, --verbose	ブール値	詳細出力を有効にします。	False
--help	ブール値	このメッセージを表示して終了します。	False

mkdocs serve

組み込みの開発サーバーを実行します。

使用方法

mkdocs serve [OPTIONS]

オプション

名前	タイプ	説明	デフォルト
-a, --dev-addr	テキスト	ドキュメントをローカルで提供するIPアドレスとポート（デフォルト：localhost:8000）	なし
--no-livereload	ブール値	開発サーバーでのライブリロードを無効にします。	False
--dirty	テキスト	変更されたファイルのみを再ビルドします。	False
-c, --clean	テキスト	mkdocs serveの影響を受けずにサイトをビルドします - 純粋なmkdocs buildを実行してから提供します。	False
--watch-theme	ブール値	ライブリロードの対象ファイルのリストにテーマを含めます。ライブリロードを使用しない場合は無視されます。	False
-w, --watch	パス	ライブリロードで監視するディレクトリまたはファイル。複数回指定できます。	[]
-f, --config-file	ファイル名	特定のMkDocs設定を指定します。ファイル名、または標準入力から読み込む場合は'-'を指定できます。	なし
-s, --strict / --no-strict	ブール値	厳格モードを有効にします。これにより、MkDocsは警告が発生するとビルドを中止します。	なし
-t, --theme	選択肢 (mkdocs | readthedocs)	ドキュメントをビルドする際に使用するテーマ。	なし
--use-directory-urls / --no-directory-urls	ブール値	ページをビルドする際にディレクトリURLを使用します（デフォルト）。	なし
-q, --quiet	ブール値	警告を非表示にします。	False
-v, --verbose	ブール値	詳細出力を有効にします。	False
--help	ブール値	このメッセージを表示して終了します。	False