From 2ce52f9530efbb49e93e43c3c6dd4f5975d53fce Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Sun, 13 Oct 2024 11:36:54 +0200 Subject: [PATCH] add some documentation --- structure/default.nix | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/structure/default.nix b/structure/default.nix index b99cf19..6d0f016 100644 --- a/structure/default.nix +++ b/structure/default.nix @@ -20,6 +20,20 @@ in { description = '' Named collections of unnamed pages + + Define the content type of a new collection `example` to be `article`: + + ```nix + config.collections.example.type = config.types.article; + ``` + + Add a new entry to the `example` collection: + + ```nix + config.collections.example.entry = { + # contents here + } + ``` ''; type = with types; attrsOf (submodule ({ name, config, ... }: { options = {