設定オプション
以下の表は、Jekyllで使用可能な設定と、それらを制御する様々なオプション
(設定ファイルで指定)とフラグ
(コマンドラインで指定)を示しています。
グローバル設定
設定項目 | オプションとフラグ |
---|---|
サイトソース Jekyllがファイルを読み込むディレクトリを変更します。 |
|
サイト出力先 Jekyllがファイルを出力するディレクトリを変更します。 |
|
セーフモード ホワイトリストに登録されていないプラグインを無効にし、ディスクへのキャッシュを無効にし、シンボリックリンクを無視します。 |
|
ディスクキャッシュの無効化 4.1.0 仮想環境やサードパーティのディレクトリ監視ツールとの干渉を避けるため、ソースに |
|
テーマ設定の無視 4.1.0 Jekyll 4.0では、テーマに |
|
除外 変換からディレクトリやファイルを削除します。これらの除外は、サイトのソースディレクトリを基準としており、ソースディレクトリの外部にあることはできません。
|
|
含める 変換にディレクトリやファイルを強制的に含めます。ドットファイルはデフォルトで除外されるため、 |
|
ファイルを保持 サイトの出力先を上書きする際に、選択したファイルを保持します。Jekyllによって生成されないファイル(ビルドツールによって生成されるファイルやアセットなど)に役立ちます。パスは |
|
タイムゾーン サイト生成のタイムゾーンを設定します。これにより、Rubyが時間と日付の作成と操作を行う際に使用する |
|
エンコーディング ファイルのエンコーディングを名前で設定します(Ruby 1.9以降でのみ使用可能)。デフォルト値は2.0.0以降では |
|
デフォルト値 フロントマター変数のデフォルト値を設定します。 |
下記を参照してください。 |
サイトビルド時に出力先フォルダがクリーンアップされます
サイトがビルドされると、デフォルトで<destination>
の内容は自動的にクリーンアップされます。サイトによって作成されないファイルやフォルダは削除されます。一部のファイルは、<keep_files>
設定ディレクティブ内で指定することで保持できます。
<destination>
には重要な場所を使用しないでください。代わりに、ステージングエリアとして使用し、そこからWebサーバーにファイルをコピーしてください。
ビルドコマンドオプション
設定項目 | オプションとフラグ |
---|---|
自動再生成 ファイルが変更されたときにサイトの自動再生成を有効にします。 |
|
設定 自動的に`_config.yml`を使用する代わりに、設定ファイル名を指定します。後のファイルの設定は、前のファイルの設定を上書きします。 |
|
プラグイン 自動的に`_plugins/`を使用する代わりに、プラグインディレクトリを指定します。 |
|
レイアウト 自動的に`_layouts/`を使用する代わりに、レイアウトディレクトリを指定します。 |
|
下書き 下書きの投稿を処理してレンダリングします。 |
|
環境 ビルドで特定の環境値を使用します。 |
|
未来の日付 未来の日付を持つ投稿またはコレクションドキュメントを公開します。 |
|
未公開 未公開としてマークされた投稿をレンダリングします。 |
|
LSI 関連する投稿のインデックスを作成します。classifier-rebornプラグインが必要です。 |
|
投稿の制限 解析および公開する投稿の数を制限します。 |
|
ポーリングの強制 監視にポーリングを強制的に使用します。 |
|
詳細出力 詳細出力を表示します。 |
|
出力の抑制 ビルド中のJekyllからの通常の出力を抑制します。 |
|
ログレベル debug、info、warn、errorの中からログレベルを指定します。 |
|
インクリメンタルビルド 実験的なインクリメンタルビルド機能を有効にします。インクリメンタルビルドは変更された投稿とページのみを再ビルドするため、大規模なサイトのパフォーマンスが大幅に向上しますが、場合によってはサイト生成が中断される可能性もあります。 |
|
バンドル不要の無効化 `:jekyll_plugins` Gemfile でgemをrequireする必要を無効化します。 |
|
Liquidプロファイラ パフォーマンスのボトルネックを特定するために役立つLiquidレンダリングプロファイルを作成します。 |
|
厳格なフロントマター ページのフロントマターにYAML構文エラーがある場合、ビルドを失敗させます。 |
|
ベースURL 指定されたベースURLからウェブサイトを提供します。 |
|
トレース エラーが発生したときに完全なバックトレースを表示します。 |
|
serveコマンドオプション
以下のオプションに加えて、serve
サブコマンドはbuild
サブコマンドの任意のオプションを受け入れることができ、それらはサイトが提供される直前に実行されるサイトビルドに適用されます。
設定項目 | オプションとフラグ |
---|---|
ローカルサーバーポート 指定されたポートで待ち受けます。デフォルトは`4000`です。 |
|
ローカルサーバーホスト名 指定されたホスト名で待ち受けます。デフォルトは`localhost`です。 |
|
ライブリロード コンテンツが編集されたときに、ブラウザでページを自動的にリロードします。 |
|
ライブリロードの無視 LiveReloadで無視するファイルのglobパターン。 |
|
ライブリロードの最小/最大遅延 ページを自動的にリロードする前の最小/最大遅延。 |
|
ライブリロードポート LiveReloadが待ち受けるポート。 |
|
URLを開く ブラウザでサイトのURLを開きます。 |
|
デタッチ サーバーをターミナルからデタッチします。 |
|
最初のサイトビルドをスキップ サーバーが開始される前に実行される最初のサイトビルドをスキップします。 |
|
ディレクトリ一覧の表示 インデックスファイルを読み込む代わりに、ディレクトリ一覧を表示します。 |
|
X.509(SSL)秘密鍵 サイトソースに保存またはシンボリックリンクされたSSL秘密鍵。 |
|
X.509(SSL)証明書 サイトソースに保存またはシンボリックリンクされたSSL公開証明書。 |
|
設定ファイルでタブを使用しない
これにより、構文エラーが発生するか、Jekyllがデフォルトの設定に戻ります。代わりにスペースを使用してください。