パーマリンク
パーマリンクは、ページやポスト、コレクションを出力するパスです。ソースコードのディレクトリ構成と出力するディレクトリ構成を変えることも可能です。
Front Matter
パーマリンクを設定するシンプルな方法は、front matterを使用することです。front matterのpermalink
変数に、好きな出力パスを設定します。
例えば、/my_pages/about-me.html
のページの出力するURLを/about/
にしたい場合は、ページのfront matterを次のようにセットします。
---
permalink: /about/
---
グローバル
パーマリンクを全てのページのfront matterで設定するのは大変です。幸運なことに、Jekyllでは_config.yml
でサイト全体のパーマリンクの構成を設定できます。
全体的なパーマリンクを設定するには、_config.yml
でpermalink
変数を使用します。望む出力になるように置換用変数(placeholders)を使用できます。例えば:
permalink: /:categories/:year/:month/:day/:title:output_ext
ページや(posts
とdrafts
を除く)コレクションには時刻やカテゴリが無いことに注意してください(ページの場合、上記の:title
は:basename
と同等です)。これらのパーマリンクスタイルは出力時には無視されます。
パーマリンクスタイルの例は、posts
コレクションなら/:categories/:year/:month/:day/:title:output_ext
、ページや(posts
とdrafts
を除く)コレクションなら/:title.html
です。
置換用変数(Placeholders)
使用できる全置換用変数(Placeholders)のリストです。
変数 | 説明 |
---|---|
|
ポストのファイル名から取得した4桁の年。ドキュメントのfront matterの |
|
ポストのファイル名から取得した西暦の下2桁。ドキュメントのfront matterの |
|
ポストのファイル名から取得した月(2桁)。ドキュメントのfront matterの |
|
ポストのファイル名から取得した月(10 の位の0なし)。ドキュメントのfront matterの |
|
3文字表記の月。“Jan”など。 |
|
月のフルネーム。“January”など。 |
|
ポストのファイル名から取得した日(2桁)。ドキュメントのfront matterの |
|
ポストのファイル名から取得した日(10 の位の0なし)。ドキュメントのfront matterの |
|
ポストのファイル名から取得した、その年の何日目か。 (001..366) |
|
週の所属する年。1月の始めと12月の終わりは月の所属する年と異なる場合があります。 |
|
その年の何週目か。ただし、1月の日が大部分を占める週から始まります。 (01..53) |
|
<p月曜日を1とする曜日。(1..7)</p> |
|
3文字表記の曜日。“Sun”など |
|
曜日名。“Sunday”など。 |
|
ポストのfront matterの |
|
ポストのfront matterの |
|
ポストのfront matterの |
|
ドキュメントのファイル名から取得したタイトル。front matterの |
|
ドキュメントのファイル名からのタイトルをスラグ化(数字と文字を除くすべての文字はハイフンに置き換えらる)したもの。front matterの |
|
ポストのカテゴリ。ポストに複数のカテゴリがある場合、Jekyllは |
|
このポストのslugifiedカテゴリ。カテゴリが複数の単語で構成されている場合、Jekyllは全てのアルファベットを小文字にし、アルファベットでない文字をハイフンに置き換えます。(例 ポストに複数のカテゴリがある場合、Jekyllは階層化します(例 |
組み込みフォーマット
Jekyllはポストに、以下の便利な組み込みスタイルを提供します。
パーマリンクスタイル | URLテンプレート |
---|---|
|
|
|
|
|
|
|
|
|
|
permalink: /:categories/:year/:month/:day/:title/
と書く代わりに、permalink: pretty
とすることができます。
front matterでのパーマリンクの指定
組み込みパーマリンクスタイルはfront matterでは認識されません。ですので、 permalink: pretty
は機能しません。
コレクション
コレクション(posts
とdraft
を含む)は、_config.yml
のコレクションの設定でグローバルパーマリンクを上書きできるオプションがあります。
collections:
my_collection:
output: true
permalink: /:collection/:name
コレクションは以下の置換用変数を使用できます。
変数 | 説明 |
---|---|
|
どのコレクションかのラベル。 |
|
コレクションのディレクトリからの相対パス。ドキュメントのベースファイル名を含みます。 |
|
ドキュメントのベースファイル名。空白及びアルファベット以外の文字はハイフンに置き換えられます。 |
|
|
|
出力ファイルの拡張子。(デフォルトで含まれており、通常は不要です。) |
ページ
ぺーじでは、front matterを用いてグローバルパーマリンクを上書きでき、_config.yml
のfront matterデフォルトを介してパーマリンクを設定していた場合、無視されます
ページは以下の置換用変数を使用できます。
変数 | 説明 |
---|---|
|
ページのベースファイル名を除いた、サイトのソースディレクトリへのページの相対パス。 |
|
ページのベースファイル名 |
|
出力ファイルの拡張子。(デフォルトで含まれており、通常は不要です。) |