コマンド

init

$ hexo init [folder]

ウェブサイトを初期化します。フォルダを指定しない場合、Hexoは現在のディレクトリにウェブサイトをセットアップします。

このコマンドは、以下の手順を実行するショートカットです。

  1. hexo-starterhexo-theme-landscapeを含む)を、指定されたターゲットフォルダまたは現在のディレクトリにGit cloneします。
  2. パッケージマネージャーを使用して依存関係をインストールします:インストールされているものがあればYarn 1pnpm、またはnpmを使用します。複数インストールされている場合は、リストされている順に優先順位が付けられます。npmはデフォルトでNode.jsにバンドルされています。

new

$ hexo new [layout] <title>

新しい記事を作成します。レイアウトを指定しない場合、Hexoは_config.ymlの`default_layout`を使用します。ドラフトを作成するには、`draft`レイアウトを使用します。タイトルにスペースが含まれる場合は、引用符で囲んでください。

オプション 説明
-p, --path 投稿パス。投稿のパスをカスタマイズします。
-r, --replace 既存の投稿を置換します。
-s, --slug 投稿のスラッグ。投稿のURLをカスタマイズします。

デフォルトでは、Hexoはタイトルを使用してファイルのパスを定義します。ページの場合、その名前のディレクトリと、その中の`index.md`ファイルを作成します。この動作を上書きしてファイルパスを定義するには、`--path`オプションを使用します。

hexo new page --path about/me "About me"

例:「About me」というタイトルをフロントマターに設定した`source/about/me.md`ファイルを作成します。

タイトルは必須です。例えば、以下のようにすると予期せぬ結果になります。

hexo new page --path about/me

これは、引数が1つだけ(`page`)で、デフォルトのレイアウトが`post`であるため、フロントマターにタイトル「page」が設定された投稿`source/_posts/about/me.md`が作成されます。

generate

$ hexo generate

静的ファイルを生成します。

オプション 説明
-d, --deploy 生成完了後にデプロイします。
-w, --watch ファイルの変更を監視します。
-b, --bail 生成中に未処理の例外がスローされた場合、エラーを発生させます。
-f, --force 強制的に再生成します。
-c, --concurrency 並列に生成されるファイルの最大数。デフォルトは無制限です。

publish

$ hexo publish [layout] <filename>

ドラフトを公開します。

server

$ hexo server

ローカルサーバーを起動します。デフォルトでは、`http://localhost:4000/`です。

オプション 説明
-p, --port デフォルトのポートを上書きします。
-s, --static 静的ファイルのみを提供します。
-l, --log ロガーを有効にします。ロガーのフォーマットを上書きします。

deploy

$ hexo deploy

ウェブサイトをデプロイします。

オプション 説明
-g, --generate デプロイ前に生成します。

render

$ hexo render <file1> [file2] ...

ファイルをレンダリングします。

オプション 説明
-o, --output 出力先

migrate

$ hexo migrate <type>

移行 他のブログシステムからコンテンツを移行します。

clean

$ hexo clean

キャッシュファイル(`db.json`)と生成されたファイル(`public`)をクリーンアップします。

list

$ hexo list <type>

すべてのルートをリストします。

version

$ hexo version

バージョン情報を表示します。

config

$ hexo config [key] [value]

設定(`_config.yml`)をリストします。`key`を指定すると、設定内の対応する`key`の値のみが表示されます。`key`と`value`の両方を指定すると、設定内の対応する`key`の値が`value`に変更されます。

オプション

セーフモード

$ hexo --safe

プラグインとスクリプトの読み込みを無効にします。新しいプラグインをインストールした後に問題が発生した場合は、試してみてください。

デバッグモード

$ hexo --debug

冗長なメッセージをターミナルと`debug.log`に出力します。Hexoで問題が発生した場合は、試してみてください。エラーが表示される場合は、GitHub issue を作成してください

サイレントモード

$ hexo --silent

ターミナルへの出力を抑制します。

設定ファイルパスのカスタマイズ

$ hexo --config custom.yml

(`_config.yml`の代わりに)カスタム設定ファイルを使用します。JSONまたはYAML設定ファイルのコンマ区切りリスト(スペースなし)も受け付け、これらのファイルを単一の`_multiconfig.yml`に結合します。

$ hexo --config custom.yml,custom2.json

ドラフトの表示

$ hexo --draft

(`source/_drafts`フォルダに保存されている)ドラフト投稿を表示します。

CWDのカスタマイズ

$ hexo --cwd /path/to/cwd

現在の作業ディレクトリのパスをカスタマイズします。