設定オプション

以下の表は、Jekyllで使用可能な設定と、それらを制御する様々なオプション(設定ファイルで指定)とフラグ(コマンドラインで指定)を示しています。

グローバル設定

設定項目 オプションフラグ

サイトソース

Jekyllがファイルを読み込むディレクトリを変更します。

source: DIR

-s, --source DIR

サイト出力先

Jekyllがファイルを出力するディレクトリを変更します。

destination: DIR

-d, --destination DIR

セーフモード

ホワイトリストに登録されていないプラグインを無効にし、ディスクへのキャッシュを無効にし、シンボリックリンクを無視します。

safe: BOOL

--safe

ディスクキャッシュの無効化 4.1.0

仮想環境やサードパーティのディレクトリ監視ツールとの干渉を避けるため、ソースに.jekyll-cacheなどのディレクトリを作成せずに、ディスクへのコンテンツキャッシュを無効にします。セーフモードでは、ディスクへのキャッシュは常に無効になります。

disable_disk_cache: BOOL

--disable-disk-cache

テーマ設定の無視 4.1.0

Jekyll 4.0では、テーマに_config.ymlをバンドルして、新規ユーザーのテーマオンボーディングを簡素化することが可能になりました。バンドルされたテーマ設定のインポートによって、マージされたサイト設定が混乱する可能性がある場合、ユーザーはJekyllがテーマ設定を完全にインポートしないように設定できます。

ignore_theme_config: BOOL

除外

変換からディレクトリやファイルを削除します。これらの除外は、サイトのソースディレクトリを基準としており、ソースディレクトリの外部にあることはできません。
Jekyll 3では、`exclude`設定オプションがデフォルトの除外リストを置き換えます。
Jekyll 4では、ユーザーが指定したエントリがデフォルトの除外リストに追加され、`include`オプションを使用してデフォルトの除外リストエントリを上書きできます。
デフォルトの除外項目は、`jekyll new`によって作成された`_config.yml`にあります。

  • .sass-cache/
  • .jekyll-cache/
  • gemfiles/
  • Gemfile
  • Gemfile.lock
  • node_modules/
  • vendor/bundle/
  • vendor/cache/
  • vendor/gems/
  • vendor/ruby/

exclude: [DIR, FILE, ...]

含める

変換にディレクトリやファイルを強制的に含めます。ドットファイルはデフォルトで除外されるため、.htaccessが良い例です。Jekyll 4では、`include`設定オプションのエントリが`exclude`オプションのエントリを上書きします。

include: [DIR, FILE, ...]

ファイルを保持

サイトの出力先を上書きする際に、選択したファイルを保持します。Jekyllによって生成されないファイル(ビルドツールによって生成されるファイルやアセットなど)に役立ちます。パスはdestinationを基準とします。

keep_files: [DIR, FILE, ...]

タイムゾーン

サイト生成のタイムゾーンを設定します。これにより、Rubyが時間と日付の作成と操作を行う際に使用するTZ環境変数が設定されます。 IANAタイムゾーンデータベースの任意のエントリ(例:America/New_York)が有効です。使用可能な値のリストはこちらにあります。ローカルマシンでサービスを提供する場合、デフォルトのタイムゾーンはオペレーティングシステムによって設定されます。しかし、リモートホスト/サーバーでサービスを提供する場合、デフォルトのタイムゾーンはサーバーの設定または場所に依存します。

timezone: TIMEZONE

エンコーディング

ファイルのエンコーディングを名前で設定します(Ruby 1.9以降でのみ使用可能)。デフォルト値は2.0.0以降ではutf-8、2.0.0以前ではnilで、RubyのデフォルトのASCII-8BITになります。使用可能なエンコーディングは、コマンドruby -e 'puts Encoding::list.join("\n")'で表示できます。

encoding: ENCODING

デフォルト値

フロントマター変数のデフォルト値を設定します。

下記を参照してください。

サイトビルド時に出力先フォルダがクリーンアップされます

サイトがビルドされると、デフォルトで<destination>の内容は自動的にクリーンアップされます。サイトによって作成されないファイルやフォルダは削除されます。一部のファイルは、<keep_files>設定ディレクティブ内で指定することで保持できます。

<destination>には重要な場所を使用しないでください。代わりに、ステージングエリアとして使用し、そこからWebサーバーにファイルをコピーしてください。

ビルドコマンドオプション

設定項目 オプションフラグ

自動再生成

ファイルが変更されたときにサイトの自動再生成を有効にします。

-w, --[no-]watch

設定

自動的に`_config.yml`を使用する代わりに、設定ファイル名を指定します。後のファイルの設定は、前のファイルの設定を上書きします。

--config FILE1[,FILE2,...]

プラグイン

自動的に`_plugins/`を使用する代わりに、プラグインディレクトリを指定します。

plugins_dir: [ DIR1,... ]

-p, --plugins DIR1[,DIR2,...]

レイアウト

自動的に`_layouts/`を使用する代わりに、レイアウトディレクトリを指定します。

layouts_dir: DIR

--layouts DIR

下書き

下書きの投稿を処理してレンダリングします。

show_drafts: BOOL

-D, --drafts

環境

ビルドで特定の環境値を使用します。

JEKYLL_ENV=production

未来の日付

未来の日付を持つ投稿またはコレクションドキュメントを公開します。

future: BOOL

--future

未公開

未公開としてマークされた投稿をレンダリングします。

unpublished: BOOL

--unpublished

LSI

関連する投稿のインデックスを作成します。classifier-rebornプラグインが必要です。

lsi: BOOL

--lsi

投稿の制限

解析および公開する投稿の数を制限します。

limit_posts: NUM

--limit_posts NUM

ポーリングの強制

監視にポーリングを強制的に使用します。

force_polling: BOOL

--force_polling

詳細出力

詳細出力を表示します。

verbose: BOOL

-V, --verbose

出力の抑制

ビルド中のJekyllからの通常の出力を抑制します。

quiet: BOOL

-q, --quiet

ログレベル

debug、info、warn、errorの中からログレベルを指定します。

JEKYLL_LOG_LEVEL=info

インクリメンタルビルド

実験的なインクリメンタルビルド機能を有効にします。インクリメンタルビルドは変更された投稿とページのみを再ビルドするため、大規模なサイトのパフォーマンスが大幅に向上しますが、場合によってはサイト生成が中断される可能性もあります。

incremental: BOOL

-I, --incremental

バンドル不要の無効化

`:jekyll_plugins` Gemfile でgemをrequireする必要を無効化します。

JEKYLL_NO_BUNDLER_REQUIRE=true

Liquidプロファイラ

パフォーマンスのボトルネックを特定するために役立つLiquidレンダリングプロファイルを作成します。

profile: BOOL

--profile

厳格なフロントマター

ページのフロントマターにYAML構文エラーがある場合、ビルドを失敗させます。

strict_front_matter: BOOL

--strict_front_matter

ベースURL

指定されたベースURLからウェブサイトを提供します。

baseurl: URL

-b, --baseurl URL

トレース

エラーが発生したときに完全なバックトレースを表示します。

-t, --trace

serveコマンドオプション

以下のオプションに加えて、serveサブコマンドはbuildサブコマンドの任意のオプションを受け入れることができ、それらはサイトが提供される直前に実行されるサイトビルドに適用されます。

設定項目 オプションフラグ

ローカルサーバーポート

指定されたポートで待ち受けます。デフォルトは`4000`です。

port: PORT

-P, --port PORT

ローカルサーバーホスト名

指定されたホスト名で待ち受けます。デフォルトは`localhost`です。

host: HOSTNAME

-H, --host HOSTNAME

ライブリロード

コンテンツが編集されたときに、ブラウザでページを自動的にリロードします。

livereload: BOOL

-l, --livereload

ライブリロードの無視

LiveReloadで無視するファイルのglobパターン。

livereload_ignore: [ GLOB1,... ]

--livereload-ignore GLOB1[,GLOB2,...]

ライブリロードの最小/最大遅延

ページを自動的にリロードする前の最小/最大遅延。

livereload_min_delay: SECONDS
livereload_max_delay: SECONDS

--livereload-min-delay SECONDS
--livereload-max-delay SECONDS

ライブリロードポート

LiveReloadが待ち受けるポート。

--livereload-port PORT

URLを開く

ブラウザでサイトのURLを開きます。

open_url: BOOL

-o, --open-url

デタッチ

サーバーをターミナルからデタッチします。

detach: BOOL

-B, --detach

最初のサイトビルドをスキップ

サーバーが開始される前に実行される最初のサイトビルドをスキップします。

skip_initial_build: BOOL

--skip-initial-build

ディレクトリ一覧の表示

インデックスファイルを読み込む代わりに、ディレクトリ一覧を表示します。

show_dir_listing: BOOL

--show-dir-listing

X.509(SSL)秘密鍵

サイトソースに保存またはシンボリックリンクされたSSL秘密鍵。

--ssl-key

X.509(SSL)証明書

サイトソースに保存またはシンボリックリンクされたSSL公開証明書。

--ssl-cert

設定ファイルでタブを使用しない

これにより、構文エラーが発生するか、Jekyllがデフォルトの設定に戻ります。代わりにスペースを使用してください。