フィード

Atom/RSSフィードは、typeをfeedと指定したYAMLファイルで定義します。

フィード定義の例: contents/atom.ymlファイル

type: feed             # YAMLファイルのタイプを feed に指定
feedtype: atom         # Atomフィードを作成
feed_num_articles: 10  # 最新10件を出力

プロパティ

feedオブジェクトには、以下のプロパティを指定できます。

フィードの種類を、atom または rss で指定します。未指定の場合は atom となります。

フィードに出力するファイルの件数を指定します。

表示するファイルの検索条件を指定します。検索する文書プロパティ名をキー、表示対象のプロパティ値のリストを値とする辞書を指定します。

省略時は、プロパティ draft が false で、date が指定されているすべてのファイルを表示します。

例: カテゴリが 'news' または 'event' の日本語ファイルのみを表示

type: feed
filters:
  lang: [ja]  # langが日本語
  category: [news, event]  # カテゴリが news または events

インデックスに含めないファイルの検索条件を指定します。検索する文書プロパティ名をキー、表示対象のプロパティ値のリストを値とする辞書を指定します。

例: タグが 'Programming'のファイルを除外

type: feed
excludes:
  tags: [programming]  # タグが programming

表示するファイルのディレクトリのリストを、絶対パスまたは相対パスで指定します。次の例を contents/feeds/atom.yml に保存すると、contents/docs ディレクトリとcontents/index/subdir/ ディレクトリ以下のファイルを出力します。

# contents/index/index.yml
type: feed
directories:
  - /docs
  - ./subdir