オプション設定
以下の表は、Jekyllで使用可能な設定と、それらを制御する様々なoptions
(設定ファイルで指定)とflags
(コマンドラインで指定)です。
グローバル設定
設定 | OptionsとFlags |
---|---|
Site Source Jekyllが読むファイルのディレクトリを変更 |
|
Site Destination Jekyllが書き出すファイルのディレクトリを変更 |
|
Safe カスタムプラグインを無効にし、ディスクにキャッシュしシンボリックリンクを無視する。 |
|
Disable Disk Cache 4.1.0
仮想環境やサードパーティのディレクトリウォッチャーとの干渉を回避するために、 |
|
Ignore theme configuration 4.1.0
Jekyll 4.0では、テーマを |
|
Exclude ファイルやディレクトリを変換時に除外する。サイトのソースディレクトリからの相対パスで指定し、ソースディレクトリ外にはならない。 |
|
Include
ディレクトリやファイルを強制的に変換に含める。ドットから始まるファイルはデフォルトでは無視されるため、 |
|
Keep files
サイトの出力先に変更を加える際に、選択したファイルを残す。Jekyllが生成しないファイル、例えばビルドツールが生成したファイルやアセット、に便利です。パスは |
|
Time Zone
サイト生成時のタイムゾーンを設定。これは |
|
Encoding
ファイルのエンコーディングを名前で設定する(Ruby 1.9以降のみ)。デフォルト値は2.0.0以降では |
|
Defaults front matter変数のデフォルト値を設定する。 |
こちらをご覧ください |
出力先は、サイト構築時に消去されます。
<destination>
コンテンツは出力時にデフォルトで自動的に消去されます。サイトで生成されないファイルやフォルダは消去されます。<keep_files>
で指定することで、消去を防ぐことができます。
<destination>
に重要な場所を設定しないでください。ステージング領域として使用し、そこからWebサーバーにコピーしてください。
Buildコマンドオプション
設定 | OptionsとFlags |
---|---|
Regeneration ファイルを修正したときのサイトの自動再生成を有効にする |
|
Configuration
|
|
Drafts ドラフトを処理してレンダリングする。 |
|
Environment ビルド時に特定の環境値を使用する。 |
|
Future 未来の日付のポストやコレクションドキュメントを公開する。 |
|
Unpublished unpublishedとしてマークされたポストをレンダリングする。 |
|
LSI 関連記事のインデックスを作成する。classifier-rebornプラグインが必要。 |
|
Limit Posts 解析及び公開する投稿数のリミット。 |
|
Force polling pollingを使用するようwatchを強要する。 |
|
Verbose output 詳細な出力をプリントする。 |
|
Silence Output ビルド時のJekyllからの通常の出力を黙らせる。 |
|
Incremental build 実験的なインクリメンタルビルド機能を有効にする。インクリメンタルビルドでは、変更された投稿とページのみが再ビルドされるため、大規模サイトではパフォーマンスが大幅に向上するが、場合によってはサイトの生成が中断されることもある。 |
|
Liquid profiler パフォーマンスのボトルネックを特定するのに役立つLiquidレンダリングプロファイルを生成する。 |
|
Strict Front Matter ページのfront matterのYAML構文にエラーがあるとビルドを失敗するようにする。 |
|
Base URL 与えられたベースURLでWebサイトを提供する |
|
Serveコマンドオプション
以下のオプションに加えて、`serve`サブコマンドは`build`サブコマンドを受け入れることができます。これらのオプションはサイトが供給される直前の構築時に適用されます。
設定 | OptionsとFlags |
---|---|
Local Server Port 与えられたポートに従う |
|
Local Server Hostname 与えられたホスト名に従う |
|
Live Reload 内容を変更した場合に、自動でページを再読込する。 |
|
Detach ターミナルからサーバーを切り離す |
|
Skips the initial site build. サーバー開始時の最初のサイト構築をスキップする |
|
X.509 (SSL) Private Key サイトのソースに保存またはシンボリックリンクされている、SSLプライベートキー |
|
X.509 (SSL) Certificate サイトのソースに保存またはシンボリックリンクされている、SSL公開証明書 |
|
設定ファイルにはtabを使わないでください
構文解析エラーに繋がったり、Jekyllの設定がデフォルトに戻ることになります。代わりにスペースを使用してください。