From 3174d19ee5282835784cb93d2fea9b26ac0b5dd6 Mon Sep 17 00:00:00 2001 From: Itay Shakury Date: Tue, 22 Oct 2019 16:19:42 +0300 Subject: [PATCH] clarify _config.yml/collections type (#7873) Merge pull request 7873 --- docs/_docs/collections.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/_docs/collections.md b/docs/_docs/collections.md index 2ec1dfb7..632a23fb 100644 --- a/docs/_docs/collections.md +++ b/docs/_docs/collections.md @@ -15,8 +15,8 @@ example here's a collection of staff members: collections: - staff_members ``` - -You can optionally specify metadata for your collection in the configuration: +In this case `collections` is defined as a sequence (i.e array) with no additional metadata defined for each collection. +You can optionally specify metadata for your collection by defining `collections` as a mapping (i.e hashmap) instead of sequence, and then defining additional fields in it: ```yaml collections: @@ -24,6 +24,10 @@ collections: people: true ``` +
+

When defining a collection as a sequence, it's pages will not be rendered by default. To enable this, output: true must be specified on the collection, which requires defining the collection as a mapping. For more information, see the section Output

+
+
Gather your collections {%- include docs_version_badge.html version="3.7.0" -%}