NKSSG
NakaKen Static Site Generator

セクションアーカイブ

📒

ここでは、サイト作成で使うことになる、セクションアーカイブについて説明します。また、他のページタイプやアーカイブについても説明します。

アーカイブの種類

NKSSG で作成される HTML ファイルは、その性質によって、次の3つに分かれます。

  • 個別ページ (single)
  • アーカイブページ (archive)
  • その他のページ

これを ページタイプ と呼んでいます。

個別ページ (single) は、コンテンツを含んだページのことです。./docs フォルダ内の1つ1つのファイルが、それぞれの個別ページと対応しています。

アーカイブページ (archive) は、個別ページを一覧にしたページのことです。これらは、個別ページの持つ情報によって、自動で作成されます。

アーカイブは、次の3種類に分けられます。

  • 日付アーカイブ
  • タクソノミーアーカイブ
  • セクションアーカイブ

日付アーカイブ は、投稿タイプごとに、個別ページを日付順に並べて一覧にしたものです。年別に分けたものと、月別に分けたものがあります。デフォルトでは /post_type/yyyy/mm というような URL になります。ブログで使うことを想定しています。

タクソノミーアーカイブ は、タクソノミーごと、タームごとに、個別ページをグループ化して一覧にしたものです。デフォルトでは、例えば、 /category/ には、 category が設定されている記事一覧が表示されます。 /category/cat1/ には、その中で cat1 というタームが設定されている記事一覧が表示されます。

セクションアーカイブ は、投稿タイプごとに、個別ページをフォルダ階層にそって並べて一覧にしたものです。デフォルトでは、フォルダの階層がそのまま URL に反映されます。階層型サイトで使うことを想定しています。

日付アーカイブとセクションアーカイブは、投稿タイプごとにグループ化されますが、タクソノミーアーカイブはサイト内の記事全体でグループ化されます。例えば、post 内の記事にも page 内の記事にもカテゴリーを設定できますが、カテゴリーを設定した post の記事一覧を表示するためのアーカイブはありません。

タクソノミーは、サイト全体を横断して個別ページをグループ化する、という点に注意しましょう。

セクションアーカイブにコンテンツを追加

アーカイブのうち、セクションアーカイブについては、記事の一覧を表示するだけでなく、テキストを追加することができます。また、タイトルやスラッグなど、個別ページと同じような設定を追加することもできます。

セクションアーカイブ用のindexファイル

次のようなフォルダ構造のサイトがあったとします。

docs
└── guide
    ├── _000_getting-start
    │   ├── _010_nkssg-overview.md
    │   ├── _020_static-site-generator.md
    │   └── _030_quick-start.md
    └── _100_blog
        └── _010_blog-overview.md

フォルダ名やファイル名の前にある番号は、easy sort 機能に関連するものです。次の記事で解説しています。

😊 簡単に記事を並べる方法

パーマリンクを設定していなければ、例えば、/guide/getting-start/index.html というセクションアーカイブページができます。このページは、タイトルが「getting-start」であり、本文には直下にある3つの記事を含んだ一覧が含まれるだけです。

ここに何かコンテンツや設定を追加したい場合は、次のように index.htmlindex.md を追加します。

docs
└── guide
    ├── _000_getting-start
    │   ├── _010_nkssg-overview.md
    │   ├── _020_static-site-generator.md
    │   ├── _030_quick-start.md
    │   └── index.md
    │       ^^^^^^^^【新規追加】
    └── _100_blog
        └── _010_blog-overview.md

これで、_000_getting-start フォルダに対応するセクションアーカイブには、新しく追加した index ファイルの設定が反映されるようになります。

index ファイルには、他の記事ファイルと同じように、本文や設定を追加できます。例えば次のように追加したとしましょう。

---
title: はじめよう
---
NKSSG がどんな静的サイトジェネレータなのか、知りたい方は、[NKSSGの特徴](:nkssg-overview?)をご覧ください。使い方の流れを知りたい方は、[クイックスタート](:quick-start?)をご覧ください。

このようにすれば、 /guide/getting-start/ にアクセスすると、タイトルは「はじめよう」になり、本文も追加されます。パンくずリストに出てくるタイトルも、「はじめよう」にかわります。

メモ

本文や設定を追加することはできますが、どのように表示されるかは、テーマに依存します。default テーマでは、記事の本文やタイトルが反映されるように、セクションアーカイブ用のテンプレートを用意しています。

なお、Markdown のリンクの箇所を見てもわかりますが、ここでも、内部リンク管理プラグインを使うことができます。このプラグインについては、次の記事にまとめています。

🔗 内部リンクを使おう