Jekyllのテーマを自作する 基本編 – 第2回 – 設定ファイルを作成する

Jekyll

Jekyllテーマ自作第2回は設定ファイルの作成です。今回のサイト制作に必要な設定をしていきます。

設定ファイルで設定をする

第1回で作成した「_config.yml」に以下を記述します。YAMLの記述方法に従って記述します。

title: My Jekyll
description: >
  My Description. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
baseurl: ""
url: "http://e-joint.jp"

author:
  name: e-JOINT.jp
  email: mail@example.com
  github: ejointjp
  twitter: ejointjp

paginate: 3
paginate_path: page:num

sass:
  style: expanded

gems:
  - jekyll-paginate
  - jekyll-feed

上から順を追って説明していきます。

titleサイト名。
descriptionサイトの説明文。
baseurlサイトのドメイン以下のパス。本シリーズではなし(空欄)にします。
urlサイトの公開URL。基本的にサイト内リンクでは相対パスを使いますが、feed.xmlなどで利用されるため、記述が必要です。
author.name作者名。今回はフッターのコピーライトの部分に使います。また、author.nameは本シリーズの後半に登場するfeed.xml内でも使われます。
author.email作者のメールアドレス。author.emailは本シリーズの後半に登場するfeed.xml内でも使われます。
author.githubGithubのアカウント名を入力します。フッターのGithubマークからのリンクURLに使います。
author.twitterTwitterのアカウント名を入力します。フッターのTwitterマークのリンクURLに使います。
paginate記事一覧で、1ページに表示する記事数を設定します。これを設定することで、ページネーションが有効になります。
paginate_pathページネーションに使われるパスを設定します。デフォルトは「page:num」です。今回はデフォルトと同じ値ですが、分かりやすく記述しておきます。
sass.styleSassのコンパイルの出力スタイルを設定します。「expanded」「nested」「compact」「compressed」の4種類があります。デフォルトは「nested」です。たぶん。Sassと聞いてピンとこない方はおググりください。
gemsこのテーマで使用するgemを指定します。今回はページネーションを作成するための「jekyll-paginate」と、フィードを自動で出力するための「jekyll-feed」を使うので、この2つを記述しておきます。

設定した値の取得方法

ここで設定した値は、以降作成する各ページやレイアウト内で、以下のようにして取得し出力できます。

{{ site.設定名 }}

例えば、タイトルを表示する場合は、{{ site.title }}、Twitterアカウント名を取得する場合は{{ site.author.twitter }}となります。

さて、サイトの設定は以上です。次回は、サイトの基本レイアウトを作成していきます。

次は Jekyllのテーマを自作する 基本編 – 第3回 – 基本レイアウトを作成する