This repository has been archived on 2024-11-13. You can view files and clone it, but cannot push or open issues or pull requests.
fediversity.eu/structure/default.nix

87 lines
2.5 KiB
Nix
Raw Normal View History

2024-11-13 15:24:40 +01:00
{ config, options, lib, pkgs, ... }:
let
inherit (lib)
mkOption
types
;
cfg = config;
in
{
imports = lib.nixFiles ./.;
options.content-types = mkOption {
description = "Content types";
type = with types; attrsOf deferredModule;
};
2024-11-13 15:24:41 +01:00
2024-11-13 15:24:41 +01:00
# TODO: enable i18n, e.g. via a nested attribute for language-specific content
2024-11-13 15:24:40 +01:00
options.pages = mkOption {
description = ''
Collection of pages on the site
'';
2024-11-13 15:24:41 +01:00
type = with types; attrsOf (submodule config.content-types.page);
2024-11-13 15:24:41 +01:00
};
2024-11-13 15:24:40 +01:00
2024-11-13 15:24:41 +01:00
options.collections = mkOption {
description = ''
Named collections of unnamed pages
2024-11-13 15:24:41 +01:00
2024-11-13 15:24:41 +01:00
Define the content type of a new collection `example` to be `article`:
2024-11-13 15:24:41 +01:00
2024-11-13 15:24:41 +01:00
```nix
config.collections.example.type = config.types.article;
```
2024-11-13 15:24:41 +01:00
2024-11-13 15:24:41 +01:00
Add a new entry to the `example` collection:
2024-11-13 15:24:41 +01:00
2024-11-13 15:24:41 +01:00
```nix
config.collections.example.entry = {
# contents here
}
```
'';
type = with types; attrsOf (submodule ({ name, config, ... }: {
options = {
type = mkOption {
description = "Type of entries in the collection";
type = types.deferredModule;
};
name = mkOption {
description = "Symbolic name, used as a human-readable identifier";
type = types.str;
default = name;
};
prefixes = mkOption {
description = ''
List of historic output locations for files in the collection
2024-11-13 15:24:41 +01:00
The first element is the canonical location.
All other elements are used to create redirects to the canonical location.
2024-11-13 15:24:41 +01:00
The default entry is the symbolic name of the collection.
When changing the symbolic name, append the old one to your custom list and use `lib.mkForce` to make sure the default element will be overridden.
'';
type = with types; nonEmptyListOf str;
example = [ "." ];
default = [ config.name ];
};
entry = mkOption {
description = "An entry in the collection";
type = types.collection (types.submodule ({
imports = [ config.type ];
_module.args.collection = config;
process-locations = ls: with lib; concatMap (l: map (p: "${p}/${l}") config.prefixes) ls;
}));
2024-11-13 15:24:40 +01:00
};
2024-11-13 15:24:41 +01:00
};
}));
};
2024-11-13 15:24:40 +01:00
2024-11-13 15:24:41 +01:00
options.menus = mkOption {
description = ''
Collection navigation menus
'';
type = with types; attrsOf (submodule config.content-types.navigation);
};
2024-11-13 15:24:40 +01:00
}