diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..62d8881 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +result +*/result diff --git a/README.md b/README.md index 58cf344..c7b2b67 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,13 @@ nix template engine - takes some templates, entries and applies the templates to the entries -# usage +# examples - +check `example/` for a static website written in nte + +the example is a cut down version of [my own website](https://jacekpoz.pl) (of course also written in nte) + +# usage first add nte as an input in your project's flake diff --git a/example/base.css b/example/base.css new file mode 100644 index 0000000..ce97902 --- /dev/null +++ b/example/base.css @@ -0,0 +1,33 @@ +* { + margin: 0; + padding: 0; +} + +body { + background-color: #EEEEEE; + color: #222222; + font-size: 1.15rem; + display: flex; + flex-direction: column; + align-items: center; + margin: 0; + height: 100%; +} + +hr { + margin: 1em auto 1em; + width: 90%; +} + +#navigation { + padding-top: 1em; + display: flex; + flex-direction: row; + font-size: 1.5rem; +} + +#navigation:has(hr) hr { + margin: auto 1em auto; + height: 75%; + width: auto; +} diff --git a/example/default.nix b/example/default.nix new file mode 100644 index 0000000..fd6d5fe --- /dev/null +++ b/example/default.nix @@ -0,0 +1,57 @@ +{ + lib, + nte, + stdenv, + ... +}: let + inherit (lib.attrsets) listToAttrs; + inherit (lib.lists) map; + inherit (lib.strings) replaceStrings toLower; + + extraArgs = { + h = n: content: let + id = replaceStrings [" " ";"] ["-" "-"] (toLower content); + in /*html*/'' + # ${content} + ''; + } + // listToAttrs (map (n: { + name = "h${toString n}"; + value = text: extraArgs.h n text; + }) [ 1 2 3 4 5 6 ] + ); + + entries = [ + ./index.nix + ./posts/index.nix + ./posts/test.nix + ]; + + templates = [ + ./templates/base.nix + ./templates/post.nix + ]; +in + stdenv.mkDerivation { + name = "nte-example"; + version = "0.1.0"; + src = ./.; + + buildPhase = /*sh*/'' + runHook preBuild + + ${nte {inherit extraArgs entries templates;}} + + runHook postBuild + ''; + + installPhase = /*sh*/'' + runHook preInstall + + mkdir -p $out + cp -r ./*.css $out + cp -r ./posts/*.css $out/posts + + runHook postInstall + ''; + } diff --git a/example/index.nix b/example/index.nix new file mode 100644 index 0000000..904ea09 --- /dev/null +++ b/example/index.nix @@ -0,0 +1,14 @@ +_: { + template = "base"; + file = "index.html"; + + head = /*html*/'' + nte example + ''; + + body = /*html*/'' +

nte example site

+

this site was written in nte

+

check the sources here

+ ''; +} diff --git a/example/posts/index.css b/example/posts/index.css new file mode 100644 index 0000000..3c7d1f6 --- /dev/null +++ b/example/posts/index.css @@ -0,0 +1,27 @@ +#posts { + display: flex; + flex-direction: column; + align-items: flex-start; + width: 65%; +} + +.post-item { + display: flex; + flex-direction: row; + align-items: center; + justify-content: space-between; + width: 100%; + padding: 1em; +} + +.post-item:has(hr) hr { + margin: auto 1em auto; + height: 95%; + width: auto; +} + +.post-title { + display: flex; + flex-direction: row; + align-items: center; +} diff --git a/example/posts/index.nix b/example/posts/index.nix new file mode 100644 index 0000000..27355ce --- /dev/null +++ b/example/posts/index.nix @@ -0,0 +1,35 @@ +{ + pkgs, + ... +} @ entryArgs: let + inherit (pkgs) lib; + inherit (lib.lists) map; + inherit (lib.strings) concatStrings; +in { + template = "base"; + file = "posts/index.html"; + + head = /*html*/'' + nte posts + + ''; + + body = let + postItem = post: /*html*/'' +
+
+

${post.title}

 +
+

${post.created}

+
+ ''; + in /*html*/'' +
+ ${concatStrings (map (postFile: postItem ((import postFile) entryArgs)) + [ + ./test.nix + ] + )} +
+ ''; +} diff --git a/example/posts/post.css b/example/posts/post.css new file mode 100644 index 0000000..7907e3e --- /dev/null +++ b/example/posts/post.css @@ -0,0 +1,24 @@ +#metadata { + width: 90%; + margin: 2em auto 1em; + text-align: center; +} + +#less-metadata { + color: #555555; + margin: 1em auto 0em; +} + +hr { + width: 75%; + margin: 1em auto 1em; +} + +#content { + max-width: 80ch; + padding-bottom: 2em; +} + +p { + margin: 1em auto 1em; +} diff --git a/example/posts/test.nix b/example/posts/test.nix new file mode 100644 index 0000000..026baec --- /dev/null +++ b/example/posts/test.nix @@ -0,0 +1,56 @@ +{ + h2, + ... +}: { + template = "post"; + file = "posts/test.html"; + + title = "Test post (using nte)"; + author = "jacekpoz"; + created = "2024-05-22"; + content = /*html*/'' +

+ This is a test post on an example nte site. Feel free to read the lorem ipsum below. Its header was generated using an additional helper function added to extraArgs +

+ ${h2 "Lorem ipsum"} +

+ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas a lobortis augue. Suspendisse finibus turpis massa, eget aliquam justo ultricies eu. Aliquam augue elit, vulputate ut elit a, porta imperdiet nisi. Sed suscipit sed eros a maximus. Nullam congue sit amet metus non porta. Nunc iaculis euismod orci, sed cursus eros pellentesque sed. Sed lacinia purus nec magna mattis ullamcorper. In aliquet neque sed est pharetra posuere. Donec mauris turpis, tempus at tempor eget, pellentesque nec nibh. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Sed volutpat orci eget justo auctor bibendum. Sed elementum odio et odio vulputate congue at eu tortor. +

+ +

+ Morbi eget volutpat justo. Maecenas erat ante, interdum non odio nec, sagittis tristique orci. Ut pulvinar sem vitae odio dictum facilisis. Vestibulum sit amet tristique eros. Phasellus ac tortor arcu. In hac habitasse platea dictumst. Fusce laoreet fringilla facilisis. Vestibulum feugiat luctus elit sit amet rhoncus. Vivamus sed orci quis elit pharetra pretium eu a libero. In sed pretium ante, eget dictum augue. +

+ +

+ Maecenas odio ligula, vehicula nec eros id, rhoncus auctor ante. Sed sodales est eu sapien sollicitudin placerat. Maecenas consequat est ac condimentum faucibus. Aenean vel augue sed nunc dapibus sollicitudin. Phasellus sed nisi vel nulla aliquet pellentesque. Etiam euismod euismod felis a cursus. Morbi consequat aliquet ex, nec auctor odio varius non. Etiam finibus sem at orci semper, in volutpat odio sagittis. Etiam id mauris sit amet orci sodales tristique eget ut mauris. +

+ +

+ Vestibulum magna sem, tempor et ultricies vitae, cursus ut nunc. Ut eleifend dignissim augue, eu feugiat urna maximus nec. Praesent eget pulvinar velit, a condimentum purus. Nunc dapibus, ligula sed efficitur mattis, velit justo pharetra ipsum, eu malesuada erat erat sed orci. Integer orci orci, ultrices in ipsum et, interdum vestibulum dolor. Mauris varius tellus eu erat lobortis, et viverra ante volutpat. Nam nunc est, posuere eget bibendum tincidunt, posuere et sem. Integer egestas aliquam nibh eu viverra. +

+ +

+ Morbi in dignissim erat. Aenean non diam at libero eleifend gravida nec et lorem. Ut nibh sapien, blandit sit amet dui id, tincidunt tempor velit. Aliquam cursus libero lacus, eget pretium ligula scelerisque eget. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Integer tristique metus massa, nec auctor purus imperdiet a. Proin eu turpis quis augue mattis tempus at at dolor. Vestibulum eu justo tincidunt nibh eleifend sollicitudin at ac massa. Praesent sit amet ultricies lorem. Sed eleifend laoreet elit, ac auctor diam finibus vel. Nam iaculis felis neque, eu hendrerit ligula pellentesque in. Sed gravida lacus tempus dictum scelerisque. Ut commodo nec tellus sit amet consequat. +

+ +

+ Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Cras eleifend sit amet arcu id euismod. Suspendisse vel bibendum diam, ut posuere nunc. Cras eget purus sit amet ex consequat laoreet quis eget sapien. Pellentesque vel lacus mollis, fringilla lectus tristique, condimentum justo. Donec orci augue, efficitur eget dolor vitae, venenatis malesuada orci. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nunc eros enim, viverra sed semper ac, aliquam et odio. Curabitur a venenatis est. Praesent lacinia non enim quis gravida. +

+ +

+ Nunc porta risus a nisl commodo, in tempor est tempor. Quisque facilisis varius nunc, ac ullamcorper magna pharetra et. Aenean lectus nulla, blandit quis mi ac, bibendum convallis nunc. Proin scelerisque porttitor turpis, sed pharetra velit ullamcorper quis. Vivamus hendrerit diam ac neque commodo ornare. Curabitur hendrerit a nulla ut auctor. Nulla sed laoreet lorem. Morbi ullamcorper ipsum mollis, lobortis lectus ut, tempus lacus. Proin lobortis dui sapien, eu facilisis dui molestie at. Fusce ut suscipit nisl, nec mollis ex. Curabitur ut cursus mauris. +

+ +

+ Nulla vulputate eget sapien eget congue. Proin et gravida urna. In hendrerit posuere dolor, eget efficitur ex aliquam a. Sed tristique lacus sit amet pulvinar dignissim. Quisque volutpat mi ac posuere feugiat. Etiam elementum molestie tortor ut rhoncus. Integer at orci enim. Pellentesque malesuada, neque faucibus aliquet vehicula, ligula neque maximus mauris, non scelerisque nisl libero sit amet nibh. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. +

+ +

+ Vivamus at mattis augue, non ullamcorper diam. Ut euismod sed erat ut efficitur. Sed mollis dui sit amet ultricies rutrum. Cras sit amet justo nisl. Aliquam at orci velit. Vestibulum vel dolor ut lectus fermentum scelerisque ut ullamcorper risus. Sed diam nibh, tempor id arcu at, eleifend placerat turpis. +

+ +

+ Morbi ut bibendum mi, id finibus odio. Suspendisse commodo leo a nisi porta, sed imperdiet turpis posuere. Mauris interdum neque sit amet metus tristique semper vitae tincidunt ipsum. Phasellus bibendum nulla venenatis nisi aliquam condimentum ac eget metus. Quisque dignissim viverra interdum. Mauris non semper magna. Nam ultricies dui at lacinia fermentum. Quisque sed diam vestibulum, mollis libero eu, sollicitudin elit. Nam quis hendrerit urna, a interdum tortor. Mauris ac augue non neque malesuada eleifend. Etiam accumsan ligula hendrerit, accumsan ante id, faucibus mi. +

+ ''; +} diff --git a/example/templates/base.nix b/example/templates/base.nix new file mode 100644 index 0000000..98b4d67 --- /dev/null +++ b/example/templates/base.nix @@ -0,0 +1,25 @@ +{ + body, + head, + ... +}: { + name = "base"; + + output = /*html*/'' + + + + ${head} + + + +
+ ${body} + + + ''; +} diff --git a/example/templates/post.nix b/example/templates/post.nix new file mode 100644 index 0000000..5186e74 --- /dev/null +++ b/example/templates/post.nix @@ -0,0 +1,35 @@ +{ + title, + author, + created, + content, + ... +} @ extraArgs : let + inherit (extraArgs) file; +in { + name = "post"; + + output = { + template = "base"; + inherit file; + + head = /*html*/'' + ${title} + + ''; + body = /*html*/'' +
+

${title}

+
+

${author} | published: ${created}

+
+
+ +
+ +
+ ${content} +
+ ''; + }; +} diff --git a/flake.nix b/flake.nix index 86a46c7..7f4f839 100644 --- a/flake.nix +++ b/flake.nix @@ -9,7 +9,7 @@ systems = ["x86_64-linux" "aarch64-linux"]; forEachSystem = nixpkgs.lib.genAttrs systems; pkgsForEach = nixpkgs.legacyPackages; - in { + in rec { engines = forEachSystem ( system: let pkgs = pkgsForEach.${system}; @@ -17,5 +17,16 @@ default = import ./engine.nix pkgs; } ); + + examples = forEachSystem ( + system: let + pkgs = pkgsForEach.${system}; + in { + default = import ./example/default.nix { + inherit (pkgs) lib stdenv; + nte = engines.${system}.default; + }; + } + ); }; }