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

vitepress dev

指定されたディレクトリをルートとして使用して、VitePress 開発サーバーを起動します。デフォルトは現在のディレクトリです。現在のディレクトリで実行している場合は、dev コマンドを省略することもできます。

使用法

# start in current directory, omitting `dev`
vitepress

# start in sub directory
vitepress dev [root]

オプション

オプション	説明
--open [path]	起動時にブラウザーを開く (boolean | string)
--port <port>	ポートを指定 (number)
--base <path>	パブリックベースパス (デフォルト: /) (string)
--cors	CORS を有効にする
--strictPort	指定されたポートがすでに使用中の場合、終了する (boolean)
--force	オプティマイザーにキャッシュを無視して再バンドルさせる (boolean)

vitepress build

本番環境向けに VitePress サイトをビルドします。

使用法

vitepress build [root]

オプション

オプション	説明
--mpa (実験的)	クライアント側のハイドレーションなしでMPA モードでビルドする (boolean)
--base <path>	パブリックベースパス (デフォルト: /) (string)
--target <target>	トランスパイルターゲット (デフォルト: "modules") (string)
--outDir <dir>	cwdを基準とした出力ディレクトリ (デフォルト: <root>/.vitepress/dist) (string)
--minify [minifier]	ミニファイを有効/無効にするか、使用するミニファイアを指定する (デフォルト: "esbuild") (boolean | "terser" | "esbuild")
--assetsInlineLimit <number>	静的アセットの base64 インライン閾値 (バイト単位) (デフォルト: 4096) (number)

vitepress preview

本番ビルドをローカルでプレビューします。

使用法

vitepress preview [root]

オプション

オプション	説明
--base <path>	パブリックベースパス (デフォルト: /) (string)
--port <port>	ポートを指定 (number)

vitepress init

現在のディレクトリでセットアップウィザードを開始します。

使用法

vitepress init