ディレクトリ構成

Jekyll のコアは、テキスト変換エンジンです。 システムの背後のコンセプトはこれです: あなたが、 Markdown や Textile や ただのプレーン HTML のような 自分のお気に入りのマークアップ言語で書かれたテキストを 与えると、それはレイアウトや一連のレイアウトファイルを大量生産します。 そのプロセスを通して、あなたはどのようにサイト URL が見られるか、 取得データがレイアウトの中に表示されるかなどを微調整することができます それはすべてのテキストファイル編集を通して行われ、 静的な Web サイトは最終的な成果物となります。

基本的な Jekyll サイトは、通常このようになります:

.
├── _config.yml
├── _drafts
|   ├── begin-with-the-crazy-ideas.textile
|   └── on-simplicity-in-technology.markdown
├── _includes
|   ├── footer.html
|   └── header.html
├── _layouts
|   ├── default.html
|   └── post.html
├── _posts
|   ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
|   └── 2009-04-26-barcamp-boston-4-roundup.textile
├── _data
|   └── members.yml
├── _site
└── index.html

これらのファイルの概要はこのようになります:

ファイル / ディレクトリ 説明

_config.yml

設定項目 データを保管します。 これらのオプションの多くはコマンドラインの実行から指定することもできます。 しかし、オプションはここで指定する方が簡単です。オプションを覚えておく必要がありません。

_drafts

ドラフトは posts に出力しません。 これらのファイルのフォーマットは日付がありません: title.MARKUPドラフトの働き で使い方を学んでください。

_includes

これらは部分的な再利用を容易にするために layouts ファイルと posts ファイルによって ミックス、マッチすることができます。 liquid のタグ {% include file.ext %} は ファイルの _includes/file.ext を含むために使用されます。

_layouts

これらは posts をラップするテンプレートです。 layouts は次のセクションに記述されている YAML front matter に基づいて post 毎に選択されます。 liquid タグ {{ content }} は ウェブページにコンテンツを挿入するために使用されます。

_posts

言うならば、あなたの動的コンテンツです。 これらのファイルのフォーマットは重要で、フォーマットに従う必要があります: YEAR-MONTH-DAY-title.MARKUPパーマリンク は、各 post のためにカスタマイズすることができます。 しかし、日付とマークアップ言語はファイル名によってのみ決定されます。

_data

よく整備されたサイトデータはここに置かれるべきです。 Jekyll エンジンはこのディレクトリの全ての yaml ファイルをオートロードします。 (.yml または .yaml で終わるもの) このディレクトリの下に member.yml がある場合、あなたは site.data.members を通してコンテンツにアクセスできます。

_site

Jekyll がそれを変換すると、生成されたサイトは(デフォルトで)ここに置かれます。 あなたの .gitignore ファイルにこれを追加するのは良い考えです。

index.html や、他の HTML, Markdown, Textile ファイル

YAML Front Matter セクションを持つという条件で、 それは Jekyll によって変換されます。 同様の事がどんな .html.markdown.md 、または .textile ファイルにも サイトのルートディレクトリや、上記以外のディレクトリに起こります。

他のファイル/フォルダ

上記のリストで挙げたファイルやディレクトリを除く全てのもの ― cssimages フォルダ、 favicon.ico ファイルのような― そのまま生成したサイトにコピーされます。 もし、あなたが彼らが展開したものに興味があれば、 既に Jekyll を使用しているサイトはたくさんあります。