Skip to content

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

vitepress dev

指定したディレクトリをルートとして VitePress の開発サーバーを起動します。既定はカレントディレクトリです。カレントディレクトリで実行する場合、dev コマンドは省略できます。

使い方

sh
# カレントディレクトリで起動(`dev` を省略)
vitepress

# サブディレクトリで起動
vitepress dev [root]

オプション

オプション説明
--open [path]起動時にブラウザを開く(boolean | string
--port <port>ポート番号を指定(number
--base <path>公開時のベースパス(既定: /)(string
--corsCORS を有効化
--strictPort指定ポートが使用中なら終了(boolean
--force最適化時にキャッシュを無視して再バンドル(boolean

vitepress build

本番用に VitePress サイトをビルドします。

使い方

sh
vitepress build [root]

オプション

オプション説明
--mpa(実験的)クライアント側ハイドレーションなしの MPA モード でビルド(boolean
--base <path>公開時のベースパス(既定: /)(string
--target <target>トランスパイルターゲット(既定: "modules")(string
--outDir <dir>出力先ディレクトリ(cwd からの相対)(既定: <root>/.vitepress/dist)(string
--assetsInlineLimit <number>静的アセットを base64 インライン化する閾値(バイト)(既定: 4096)(number

vitepress preview

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

使い方

sh
vitepress preview [root]

オプション

オプション説明
--base <path>公開時のベースパス(既定: /)(string
--port <port>ポート番号を指定(number

vitepress init

カレントディレクトリで セットアップウィザード を起動します。

使い方

sh
vitepress init

MIT ライセンスの下で公開されています。