オプション設定

以下の表は、Jekyllで使用可能な設定と、それらを制御する様々なoptions(設定ファイルで指定)とflags(コマンドラインで指定)です。

グローバル設定

設定 OptionsFlags

Site Source

Jekyllが読むファイルのディレクトリを変更

source: DIR

-s, --source DIR

Site Destination

Jekyllが書き出すファイルのディレクトリを変更

destination: DIR

-d, --destination DIR

Safe

カスタムプラグインを無効にし、シンボリックリンクを無視する。

safe: BOOL

--safe

Exclude

ファイルやディレクトリを変換時に除外する。サイトのソースディレクトリからの相対パスで指定し、ソースディレクトリ外にはならない。

exclude: [DIR, FILE, ...]

Include

ディレクトリやファイルを強制的に変換に含める。ドットから始まるファイルはデフォルトでは無視されるため、.htaccessはよい例である。

include: [DIR, FILE, ...]

Keep files

サイトの出力先に変更を加える際に、選択したファイルを残す。Jekyllが生成しないファイル、例えばビルドツールが生成したファイルやアセット、に便利です。パスは出力先からの相対パスです。

keep_files: [DIR, FILE, ...]

Time Zone

サイト生成時のタイムゾーンを設定。これはTZ環境変数を設定し、Rubyが日時の作成と操作を処理するために使用する。IANA Time Zone Databaseからの全てのエントリは有効です(例:Asia/Tokyo)。 こちらに使用可能な全ての変数のリストがあります。 ローカルマシン上のサーバーの場合、デフォルトのタイムゾーンはオペレーティングシステムによって設定されます。 しかし、リモートホスト/サーバー上で提供される場合、デフォルトのタイムゾーンはサーバーの設定や場所によって異なります。

timezone: TIMEZONE

Encoding

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

encoding: ENCODING

Defaults

front matter変数のデフォルト値を設定する。

こちらをご覧ください

出力先は、サイト構築時に消去されます。

<destination>コンテンツは出力時にデフォルトで自動的に消去されます。サイトで生成されないファイルやフォルダは消去されます。<keep_files>で指定することで、消去を防ぐことができます。

<destination>に重要な場所を設定しないでください。ステージング領域として使用し、そこからWebサーバーにコピーしてください。

Buildコマンドオプション

設定 OptionsFlags

Regeneration

ファイルを修正したときのサイトの自動再生成を有効にする

-w, --[no-]watch

Configuration

_config.ymlファイルの代わりに特定の設定ファイルを使用する。後のファイルの設定は前のファイルの設定で上書きされる。

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

Drafts

ドラフトを処理してレンダリングする。

show_drafts: BOOL

--drafts

Environment

ビルド時に特定の環境値を使用する。

JEKYLL_ENV=production

Future

未来の日付のポストやコレクションドキュメントを公開する。

future: BOOL

--future

Unpublished

unpublishedとしてマークされたポストをレンダリングする。

unpublished: BOOL

--unpublished

LSI

関連記事のインデックスを作成する。classifier-rebornプラグインが必要。

lsi: BOOL

--lsi

Limit Posts

解析及び公開する投稿数のリミット。

limit_posts: NUM

--limit_posts NUM

Force polling

pollingを使用するようwatchを強要する。

--force_polling

Verbose output

詳細な出力をプリントする。

-V, --verbose

Silence Output

ビルド時のJekyllからの通常の出力を黙らせる。

-q, --quiet

Incremental build

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

incremental: BOOL

-I, --incremental

Liquid profiler

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

profile: BOOL

--profile

Strict Front Matter

ページのfront matterのYAML構文にエラーがあるとビルドを失敗するようにする。

strict_front_matter: BOOL

--strict_front_matter

Serveコマンドオプション

以下のオプションに加えて、`serve`サブコマンドは`build`サブコマンドを受け入れることができます。これらのオプションはサイトが供給される直前の構築時に適用されます。

設定 OptionsFlags

Local Server Port

与えられたポートに従う

port: PORT

--port PORT

Local Server Hostname

与えられたホスト名に従う

host: HOSTNAME

--host HOSTNAME

Base URL

与えられたベースURLでWebサイトを提供する

baseurl: URL

--baseurl URL

Live Reload

内容を変更した場合に、自動でページを再読込する。

livereload: true

--livereload

Detach

ターミナルからサーバーを切り離す

detach: BOOL

-B, --detach

Skips the initial site build.

サーバー開始時の最初のサイト構築をスキップする

--skip-initial-build

X.509 (SSL) Private Key

サイトのソースに保存またはシンボリックリンクされている、SSLプライベートキー

--ssl-key

X.509 (SSL) Certificate

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

--ssl-cert

設定ファイルにはtabを使わないでください

構文解析エラーに繋がったり、Jekyllの設定がデフォルトに戻ることになります。代わりにスペースを使用してください。