Jekyll-archives

Tags: archives , categories , dates , gem-based-plugins , tags

Jekyllのタグとカテゴリのアーカイブページを生成するプラグイン

• Homepage (github.com) [EN]
• Document (rubydoc.info) [EN]
• Usage (github.com) [EN]

日付、タグ、カテゴリ別の投稿アーカイブを自動生成します。

インストール

1. Gemfileを編集

   # Gemfile
   group :jekyll_plugins do
     gem 'jekyll-archives'
   end
   

2. _config.ymlを編集

   # _config.yml
   plugins:
     - jekyll-archives
   

3. Pluginのインストール

   bundle
   

Configuration

Default configuration ¹

jekyll-archives:
  enabled: []
  layout: archive
  permalinks:
    year: '/:year/'
    month: '/:year/:month/'
    day: '/:year/:month/:day/'
    tag: '/tag/:name/'
    category: '/category/:name/'

Layout attributes

Jekyll-archivesで自動生成されたページには、そのアーカイブの種類に基づいて ページ変数が設定されています。 設定されたページ変数は、アーカイブ固有のレイアウトの作成に利用できます。

Title (page.title)

タグ/カテゴリ名。日付ベースのアーカイブ (年、月、日) の場合はnilになります。

Date (page.date)

日付ベースのアーカイブの場合、日付ヘッダーを適切な形式で表示するために 使用できるDateオブジェクトが含まれています。 タグとカテゴリのアーカイブの場合はnilです。

Liquidの Dateフィルター を使用するとDateオブジェクトからアーカイブの「年」を取得できます。

{% assign post_year = post.date | date: "%Y" %}

Posts (page.posts)

当該アーカイブに含まれるPostオブジェクトが配列として格納されます。 これを繰り返し処理することで一覧を作成できます。

<ul>
{% for post in page.posts %}
  <li>{{ post.title }}</li>
{% endfor %}
</ul>

Type (page.type)

アーカイブの種類が格納されます。 値は、各々’tag, category, year, month, day`です。

Jekyll-sitemapのように、その処理に Front Matter の情報が必要な場合に有効です。 例えばタグのアーカイブをSitemapから除外したい場合は下記のようにします。

defaults:
  -
    scope:
      path: ""
      type: "tag"
    values:
      sitemap: false

関連プラグイン

• Jekyll-tagging - タグクラウド、タグごとのページおよびフィードを生成するプラグイン

関連ページ

• Liquid - JekyllのLiquidについて

ブログ記事

下記に掲載を希望される方はご連絡ください (詳細)

• Jekyllで年月日別ページを生成する (otti.xyz) Oct 6 2020
• Jekyll：jekyll-archives でアーカイブページを作る (mebiusbox.github.io) Jun 18 2016

Back to top