コマンド

init

$ hexo init [folder]

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

このコマンドは、以下のステップを実行するショートカットです:

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

new

$ hexo new [layout] <title>

新しい記事やページを作成します。 layoutが指定されていない場合、Hexoは_config.ymldefault_layoutを使用します。 下書きを作成するにはdraftレイアウトを使用します。 titleにスペースが含まれる場合は、引用符で囲んでください。

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

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

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

これはsource/about/me.mdファイルを作成し、Front Matterに”About me”というタイトルを設定します。

タイトルは必須です。 例えば、以下は期待した通りの挙動にはなりません:

hexo new page --path about/me

これはsource/_posts/about/me.mdに記事を作成し、Front Matterに”page”というタイトルを設定します。 これは引数が1つ(page)のみで、デフォルトレイアウトがpostであるためです。

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の値のみが表示されます。 keyvalueが両方指定された場合、設定の対応する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フォルダに保存)を表示します。

現在の作業ディレクトリのカスタマイズ

$ hexo --cwd /path/to/cwd

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