2024-11-13 15:24:40 +01:00
|
|
|
{ config, options, lib, pkgs, ... }:
|
|
|
|
|
let
|
|
|
|
|
inherit (lib)
|
|
|
|
|
mkOption
|
|
|
|
|
types
|
|
|
|
|
;
|
|
|
|
|
cfg = config;
|
|
|
|
|
in
|
|
|
|
|
{
|
2024-11-13 15:24:41 +01:00
|
|
|
imports = [ ./content-types.nix ];
|
2024-11-13 15:24:41 +01:00
|
|
|
|
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
|
|
|
|
|
|
|
|
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
|
|
|
|
|
}
|
|
|
|
|
```
|
2024-11-13 15:24:41 +01:00
|
|
|
'';
|
|
|
|
|
type = with types; attrsOf (submodule ({ name, config, ... }: {
|
|
|
|
|
options = {
|
|
|
|
|
type = mkOption {
|
|
|
|
|
description = "Type of entries in the collection";
|
|
|
|
|
type = types.deferredModule;
|
2024-11-13 15:24:40 +01:00
|
|
|
};
|
2024-11-13 15:24:41 +01:00
|
|
|
entry = mkOption {
|
|
|
|
|
description = "An entry in the collection";
|
2024-11-13 15:24:41 +01:00
|
|
|
type = types.collection (types.submodule ({
|
2024-11-13 15:24:41 +01:00
|
|
|
_module.args.collection = config.entry;
|
|
|
|
|
_module.args.collectionName = name;
|
|
|
|
|
imports = [ config.type ];
|
|
|
|
|
}));
|
2024-11-13 15:24:40 +01:00
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
}));
|
2024-11-13 15:24:41 +01:00
|
|
|
};
|
2024-11-13 15:24:40 +01:00
|
|
|
|
|
|
|
|
options.templates = mkOption {
|
|
|
|
|
description = ''
|
|
|
|
|
Collection of named functions to convert page contents to files
|
2024-11-13 15:24:41 +01:00
|
|
|
|
|
|
|
|
Each template function takes the complete site `config` and the page data structure.
|
2024-11-13 15:24:40 +01:00
|
|
|
'';
|
2024-11-13 15:24:41 +01:00
|
|
|
type = with types; attrsOf (functionTo (functionTo options.files.type));
|
2024-11-13 15:24:40 +01:00
|
|
|
};
|
2024-11-13 15:24:41 +01:00
|
|
|
# TODO: split out templates and all related helper junk into `../presentation`
|
2024-11-13 15:24:41 +01:00
|
|
|
config.templates =
|
2024-11-13 15:24:40 +01:00
|
|
|
let
|
|
|
|
|
commonmark = name: markdown: pkgs.runCommand "${name}.html"
|
|
|
|
|
{
|
|
|
|
|
buildInputs = [ pkgs.cmark ];
|
|
|
|
|
} ''
|
|
|
|
|
cmark ${builtins.toFile "${name}.md" markdown} > $out
|
|
|
|
|
'';
|
|
|
|
|
in
|
2024-11-13 15:24:41 +01:00
|
|
|
{
|
|
|
|
|
page = lib.mkDefault (config: page: {
|
|
|
|
|
# TODO: create static redirects from `tail page.locations`
|
2024-11-13 15:24:41 +01:00
|
|
|
# TODO: reconsider using `page.outPath` and what to put into `locations`.
|
|
|
|
|
# maybe we can avoid having ".html" suffixes there.
|
|
|
|
|
# since templates can output multiple files, `html` is merely one of many things we *could* produce.
|
2024-11-13 15:24:41 +01:00
|
|
|
${page.outPath} = builtins.toFile "${page.name}.html" ''
|
2024-11-13 15:24:40 +01:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
|
|
|
|
|
|
<title>${page.title}</title>
|
|
|
|
|
<meta name="description" content="${page.description}" />
|
2024-11-13 15:24:41 +01:00
|
|
|
<link rel="canonical" href="${page.outPath}" />
|
2024-11-13 15:24:40 +01:00
|
|
|
</head>
|
|
|
|
|
<body>
|
2024-11-13 15:24:41 +01:00
|
|
|
${lib.indent " " (builtins.readFile (commonmark page.name page.body))}
|
2024-11-13 15:24:40 +01:00
|
|
|
<body>
|
|
|
|
|
</html>
|
|
|
|
|
'';
|
|
|
|
|
});
|
2024-11-13 15:24:41 +01:00
|
|
|
article = lib.mkDefault (config: page: {
|
|
|
|
|
# TODO: create static redirects from `tail page.locations`
|
|
|
|
|
${page.outPath} = builtins.toFile "${page.name}.html" ''
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
|
|
|
|
|
|
<title>${page.title}</title>
|
|
|
|
|
<meta name="description" content="${page.description}" />
|
|
|
|
|
${with lib;
|
|
|
|
|
if ! isNull page.author then
|
|
|
|
|
''<meta name="author" content="${if isList page.author then join ", " page.author else page.author}" />''
|
|
|
|
|
else ""
|
|
|
|
|
}
|
|
|
|
|
<link rel="canonical" href="${page.outPath}" />
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
${lib.indent " " (builtins.readFile (commonmark page.name page.body))}
|
|
|
|
|
<body>
|
|
|
|
|
</html>
|
|
|
|
|
'';
|
|
|
|
|
});
|
|
|
|
|
};
|
2024-11-13 15:24:40 +01:00
|
|
|
|
|
|
|
|
options.files = mkOption {
|
|
|
|
|
description = ''
|
|
|
|
|
Files that make up the site, mapping from output path to contents
|
|
|
|
|
|
|
|
|
|
By default, all elements in `option`{pages} are converted to files using their template or the default template.
|
|
|
|
|
Add more files to the output by assigning to this attribute set.
|
|
|
|
|
'';
|
|
|
|
|
type = with types; attrsOf path;
|
|
|
|
|
};
|
2024-11-13 15:24:41 +01:00
|
|
|
config.files =
|
|
|
|
|
let
|
|
|
|
|
pages = lib.concatMapAttrs
|
|
|
|
|
(name: page: page.template config page)
|
|
|
|
|
config.pages;
|
|
|
|
|
collections =
|
|
|
|
|
let
|
|
|
|
|
byCollection = with lib; mapAttrs
|
|
|
|
|
(_: collection:
|
|
|
|
|
map (entry: entry.template config entry) collection.entry
|
|
|
|
|
)
|
|
|
|
|
config.collections;
|
|
|
|
|
in
|
|
|
|
|
with lib; concatMapAttrs
|
|
|
|
|
(collection: entries:
|
|
|
|
|
foldl' (acc: entry: acc // entry) { } entries
|
|
|
|
|
)
|
|
|
|
|
byCollection;
|
|
|
|
|
in
|
|
|
|
|
pages // collections;
|
|
|
|
|
|
2024-11-13 15:24:40 +01:00
|
|
|
options.build = mkOption {
|
|
|
|
|
description = ''
|
|
|
|
|
The final output of the web site
|
|
|
|
|
'';
|
|
|
|
|
type = types.package;
|
|
|
|
|
default =
|
|
|
|
|
let
|
|
|
|
|
script = ''
|
|
|
|
|
mkdir $out
|
2024-11-13 15:24:41 +01:00
|
|
|
'' + lib.join "\n" copy;
|
2024-11-13 15:24:40 +01:00
|
|
|
copy = lib.mapAttrsToList
|
|
|
|
|
(
|
|
|
|
|
path: file: ''
|
|
|
|
|
mkdir -p $out/$(dirname ${path})
|
|
|
|
|
cp -r ${file} $out/${path}
|
|
|
|
|
''
|
|
|
|
|
)
|
|
|
|
|
config.files;
|
|
|
|
|
in
|
|
|
|
|
pkgs.runCommand "source" { } script;
|
|
|
|
|
};
|
|
|
|
|
}
|
