diff --git a/.gitignore b/.gitignore index d4ba081..f18cdab 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,4 @@ _gen # downloaded by nix -themes +themes/poison diff --git a/layouts/.gitkeep b/content/posts/_index.md similarity index 100% rename from layouts/.gitkeep rename to content/posts/_index.md diff --git a/content/posts/why-i-do-not-use-flake-utils.md b/content/posts/why-i-do-not-use-flake-utils.md index 6f79f2c..0a2e428 100644 --- a/content/posts/why-i-do-not-use-flake-utils.md +++ b/content/posts/why-i-do-not-use-flake-utils.md @@ -11,7 +11,9 @@ For me the biggest advantage flakes bring is not additional functionality. Inste When learning flakes, you often see [flake-utils]( https://github.com/numtide/flake-utils) being used. With it, you can shorten your flakes by not having to specify everything per system. -### Without anything +_Edit_: The patterns described here as well as `flake-parts` are also compared in [Practical Nix flake anatomy](https://vtimofeenko.com/posts/practical-nix-flake-anatomy-a-guided-tour-of-flake.nix/#flake-utils-flakeparts-etc). + +## Without anything ```nix { @@ -33,7 +35,7 @@ When learning flakes, you often see [flake-utils]( https://github.com/numtide/fl } ``` -### With flake-utils +## With flake-utils ```nix { @@ -54,7 +56,7 @@ When learning flakes, you often see [flake-utils]( https://github.com/numtide/fl } ``` -### With function in flake +## With function in flake To make a long story short, here is what I usually do instead: @@ -94,16 +96,24 @@ For me, it wasn’t a problem to ignore boilerplate like this at first, slowly l At **[1]**, the supported systems are specified. I personally use `x86_64-linux` and `aarch64-linux`, but I also usually support `x86_64-darwin` and `aarch64-darwin` in public projects. If you want to support any system, you can use [`nixpkgs.lib.system.flake-exposed`](https://github.com/NixOS/nixpkgs/blob/374e6bcc403e02a35e07b650463c01a52b13a7c8/lib/systems/default.nix#L58) at **[2]** instead of defining your own list. -Because the definition is right inside the flake, you can tweak what gets passed to the function. For example, the [flake for RedoxOS-development](https://gitlab.redox-os.org/redox-os/redox/-/blob/cb34b9bd862f46729c0082c37a41782a3b1319c3/flake.nix#L38) I contributed[^1] this to passes the custom rust-toolchain. +### Example variations + +Because the definition is right inside the flake, you can tweak what gets passed to the function. +By doing that, you have to explicitly add the new identifier to each part that uses it, instead of having a global `let` binding that is implicitly used. +`system` being available here is another bonus, as otherwise this would require duplicate `let`s everywhere. + An example for how to do it is already right there: at **[3]**, `pkgs` is provided. +Some real-world usages I wrote or encountered: + +- [servicepoint-life flake](https://git.berlin.ccc.de/vinzenz/servicepoint-life/src/commit/5f5e10d39f09f4d60b4301e76f0158636afee6d1/flake.nix): passes in initialized `naersk` instance and a shorthand to refer to packages defined in the flake itself +- [RedoxOS development flake](https://gitlab.redox-os.org/redox-os/redox/-/blob/cb34b9bd862f46729c0082c37a41782a3b1319c3/flake.nix#L38): uses it to pass a custom rust-toolchain +- [my NixOS flake](https://git.berlin.ccc.de/vinzenz/nixos-configuration/src/commit/3d27f554015ece713fa22fe829d711b430d6bbda/flake.nix): uses something similar for per-host config Another possible tweak: You may want to define separate supported systems for each output. This is useful, for example, if the target environment you're developing for cannot support a development shell. +## Conclusion + For me, the trade-offs are worth it, as they provide greater transparency and control over the flake configuration. - -That being said, I fully acknowledge that `flake-utils` can still be a great choice for many people. -It simplifies things and reduces the need to write boilerplate code, which can be a plus depending on your needs and workflow. +For you, this may be different, in which case keep using it! Ultimately, it's also matter of personal preference. - -[^1]: If you check the history, you will see I am not mentioned. I am still a bit salty about that, as it was my first contribution to a bigger OSS project. diff --git a/content/projects/servicepoint/servicepoint.md b/content/projects/servicepoint/servicepoint.md deleted file mode 100644 index 580bdf3..0000000 --- a/content/projects/servicepoint/servicepoint.md +++ /dev/null @@ -1,5 +0,0 @@ -+++ -date = '2025-04-06T12:24:08+02:00' -draft = true -title = 'servicepoint' -+++ diff --git a/flake.lock b/flake.lock index c5f76d2..cd3f169 100644 --- a/flake.lock +++ b/flake.lock @@ -2,16 +2,16 @@ "nodes": { "nixpkgs": { "locked": { - "lastModified": 1748037224, - "narHash": "sha256-92vihpZr6dwEMV6g98M5kHZIttrWahb9iRPBm1atcPk=", + "lastModified": 1748437600, + "narHash": "sha256-hYKMs3ilp09anGO7xzfGs3JqEgUqFMnZ8GMAqI6/k04=", "owner": "nixos", "repo": "nixpkgs", - "rev": "f09dede81861f3a83f7f06641ead34f02f37597f", + "rev": "7282cb574e0607e65224d33be8241eae7cfe0979", "type": "github" }, "original": { "owner": "nixos", - "ref": "nixos-24.11", + "ref": "nixos-25.05", "repo": "nixpkgs", "type": "github" } diff --git a/flake.nix b/flake.nix index e8ecb43..25eae1b 100644 --- a/flake.nix +++ b/flake.nix @@ -2,7 +2,7 @@ description = "Flake for the contents of https://zerforschen.plus"; inputs = { - nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-24.11"; + nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-25.05"; }; outputs = @@ -28,12 +28,14 @@ devShells = forAllSystems ( { pkgs, system, ... }: { - default = pkgs.mkShellNoCC rec { + default = pkgs.mkShellNoCC { inputsFrom = [ self.packages.${system}.default ]; shellHook = '' mkdir -p themes ln -snf "${self.packages.${system}.hugo-theme-poison}" themes/poison + + alias hugo="hugo --baseURL=http://localhost/" ''; }; } diff --git a/hugo.toml b/hugo.toml index 87533cf..5ce6ecf 100644 --- a/hugo.toml +++ b/hugo.toml @@ -2,41 +2,41 @@ baseURL = '/' #languageCode = 'en-us' title = 'zerforschen+' -theme = 'poison' +theme = 'own-theme' pluralizelisttitles = false [params] - brand = "zerforschen+" - description = "" - dark_mode = true - front_page_content = ["posts", "projects"] - menu = [ - # Dict keys: - # Name: The name to display on the menu. - # URL: The directory relative to the content directory. - # HasChildren: If the directory's files should be listed. Default is true. - # Limit: If the files should be listed, how many should be shown. +brand = "zerforschen+" +description = "" +dark_mode = true +front_page_content = ["posts", "projects"] +menu = [ + # Dict keys: + # Name: The name to display on the menu. + # URL: The directory relative to the content directory. + # HasChildren: If the directory's files should be listed. Default is true. + # Limit: If the files should be listed, how many should be shown. - {Name = "About", URL = "/about/", HasChildren = false}, + { Name = "About", URL = "/about/", HasChildren = false }, - {Name = "Posts", URL = "/posts/", HasChildren = true, Limit = 99}, + { Name = "Posts", URL = "/posts/", HasChildren = true, Limit = 99 }, - # {Name = "Projects", URL = "/projects/"}, - ] + # {Name = "Projects", URL = "/projects/"}, +] - #email_url = "mailto://user@domain" - github_url = "https://github.com/kaesaecracker" - mastodon_url = "https://chaos.social/@vinzenz" - matrix_url = "https://matrix.org" - forgejo_url = "https://git.berlin.ccc.de/vinzenz" - rss_icon = true +#email_url = "mailto://user@domain" +github_url = "https://github.com/kaesaecracker" +mastodon_url = "https://chaos.social/@vinzenz" +matrix_url = "https://matrix.org" +forgejo_url = "https://git.berlin.ccc.de/vinzenz" +rss_icon = true [taxonomies] - series = 'series' - tags = 'tags' +series = 'series' +tags = 'tags' [params.meta] - favicon = true +favicon = true [pagination] - pagerSize = 10 +pagerSize = 10 diff --git a/themes/own-theme/archetypes/default.md b/themes/own-theme/archetypes/default.md new file mode 100644 index 0000000..c6f3fce --- /dev/null +++ b/themes/own-theme/archetypes/default.md @@ -0,0 +1,5 @@ ++++ +title = '{{ replace .File.ContentBaseName "-" " " | title }}' +date = {{ .Date }} +draft = true ++++ diff --git a/themes/own-theme/assets/css/main.css b/themes/own-theme/assets/css/main.css new file mode 100644 index 0000000..45e655d --- /dev/null +++ b/themes/own-theme/assets/css/main.css @@ -0,0 +1,19 @@ +body { + font-family: sans-serif; + line-height: 1.5; + margin: 1rem; +} + +header { + border-bottom: 1px solid; + margin-bottom: 1rem; +} + +footer { + border-top: 1px solid; + margin-top: 1rem; +} + +a { + text-decoration: none; +} diff --git a/themes/own-theme/assets/js/main.js b/themes/own-theme/assets/js/main.js new file mode 100644 index 0000000..e2aac52 --- /dev/null +++ b/themes/own-theme/assets/js/main.js @@ -0,0 +1 @@ +console.log('This site was generated by Hugo.'); diff --git a/themes/own-theme/hugo.toml b/themes/own-theme/hugo.toml new file mode 100644 index 0000000..6c35bc4 --- /dev/null +++ b/themes/own-theme/hugo.toml @@ -0,0 +1,23 @@ +baseURL = 'https://example.org/' +languageCode = 'en-US' +title = 'My New Hugo Site' + +[[menus.main]] +name = 'Home' +pageRef = '/' +weight = 10 + +[[menus.main]] +name = 'Posts' +pageRef = '/posts' +weight = 20 + +[[menus.main]] +name = 'Tags' +pageRef = '/tags' +weight = 30 + +[module] + [module.hugoVersion] + extended = false + min = "0.116.0" diff --git a/themes/own-theme/layouts/_default/baseof.html b/themes/own-theme/layouts/_default/baseof.html new file mode 100644 index 0000000..39dcbec --- /dev/null +++ b/themes/own-theme/layouts/_default/baseof.html @@ -0,0 +1,17 @@ + + + + {{ partial "head.html" . }} + + +
+ {{ partial "header.html" . }} +
+
+ {{ block "main" . }}{{ end }} +
+ + + diff --git a/themes/own-theme/layouts/_default/home.html b/themes/own-theme/layouts/_default/home.html new file mode 100644 index 0000000..0df6597 --- /dev/null +++ b/themes/own-theme/layouts/_default/home.html @@ -0,0 +1,7 @@ +{{ define "main" }} + {{ .Content }} + {{ range site.RegularPages }} +

{{ .LinkTitle }}

+ {{ .Summary }} + {{ end }} +{{ end }} diff --git a/themes/own-theme/layouts/_default/list.html b/themes/own-theme/layouts/_default/list.html new file mode 100644 index 0000000..50fc92d --- /dev/null +++ b/themes/own-theme/layouts/_default/list.html @@ -0,0 +1,8 @@ +{{ define "main" }} +

{{ .Title }}

+ {{ .Content }} + {{ range .Pages }} +

{{ .LinkTitle }}

+ {{ .Summary }} + {{ end }} +{{ end }} diff --git a/layouts/_default/rss.xml b/themes/own-theme/layouts/_default/rss.xml similarity index 100% rename from layouts/_default/rss.xml rename to themes/own-theme/layouts/_default/rss.xml diff --git a/themes/own-theme/layouts/_default/single.html b/themes/own-theme/layouts/_default/single.html new file mode 100644 index 0000000..7e286c8 --- /dev/null +++ b/themes/own-theme/layouts/_default/single.html @@ -0,0 +1,10 @@ +{{ define "main" }} +

{{ .Title }}

+ + {{ $dateMachine := .Date | time.Format "2006-01-02T15:04:05-07:00" }} + {{ $dateHuman := .Date | time.Format ":date_long" }} + + + {{ .Content }} + {{ partial "terms.html" (dict "taxonomy" "tags" "page" .) }} +{{ end }} diff --git a/themes/own-theme/layouts/partials/footer.html b/themes/own-theme/layouts/partials/footer.html new file mode 100644 index 0000000..e69de29 diff --git a/themes/own-theme/layouts/partials/head.html b/themes/own-theme/layouts/partials/head.html new file mode 100644 index 0000000..62ce25b --- /dev/null +++ b/themes/own-theme/layouts/partials/head.html @@ -0,0 +1,6 @@ + + +{{ if .IsHome }}{{ site.Title }}{{ else }}{{ printf "%s | %s" .Title site.Title }}{{ end }} +{{ partialCached "head/css.html" . }} +{{ partialCached "head/js.html" . }} + \ No newline at end of file diff --git a/themes/own-theme/layouts/partials/head/css.html b/themes/own-theme/layouts/partials/head/css.html new file mode 100644 index 0000000..91b928d --- /dev/null +++ b/themes/own-theme/layouts/partials/head/css.html @@ -0,0 +1,9 @@ +{{- with resources.Get "css/main.css" }} + {{- if eq hugo.Environment "development" }} + + {{- else }} + {{- with . | minify | fingerprint }} + + {{- end }} + {{- end }} +{{- end }} diff --git a/themes/own-theme/layouts/partials/head/js.html b/themes/own-theme/layouts/partials/head/js.html new file mode 100644 index 0000000..18fe842 --- /dev/null +++ b/themes/own-theme/layouts/partials/head/js.html @@ -0,0 +1,12 @@ +{{- with resources.Get "js/main.js" }} + {{- if eq hugo.Environment "development" }} + {{- with . | js.Build }} + + {{- end }} + {{- else }} + {{- $opts := dict "minify" true }} + {{- with . | js.Build $opts | fingerprint }} + + {{- end }} + {{- end }} +{{- end }} diff --git a/themes/own-theme/layouts/partials/header.html b/themes/own-theme/layouts/partials/header.html new file mode 100644 index 0000000..f23e6b8 --- /dev/null +++ b/themes/own-theme/layouts/partials/header.html @@ -0,0 +1,3 @@ +

{{ site.Title }}

+{{ partial "menu.html" (dict "menuID" "main" "page" .) }} +{{ partial "socials.html" . }} \ No newline at end of file diff --git a/themes/own-theme/layouts/partials/menu.html b/themes/own-theme/layouts/partials/menu.html new file mode 100644 index 0000000..7183180 --- /dev/null +++ b/themes/own-theme/layouts/partials/menu.html @@ -0,0 +1,51 @@ +{{- /* +Renders a menu for the given menu ID. + +@context {page} page The current page. +@context {string} menuID The menu ID. + +@example: {{ partial "menu.html" (dict "menuID" "main" "page" .) }} +*/}} + +{{- $page := .page }} +{{- $menuID := .menuID }} + +{{- with index site.Menus $menuID }} + +{{- end }} + +{{- define "partials/inline/menu/walk.html" }} + {{- $page := .page }} + {{- range .menuEntries }} + {{- $attrs := dict "href" .URL }} + {{- if $page.IsMenuCurrent .Menu . }} + {{- $attrs = merge $attrs (dict "class" "active" "aria-current" "page") }} + {{- else if $page.HasMenuCurrent .Menu .}} + {{- $attrs = merge $attrs (dict "class" "ancestor" "aria-current" "true") }} + {{- end }} + {{- $name := .Name }} + {{- with .Identifier }} + {{- with T . }} + {{- $name = . }} + {{- end }} + {{- end }} +
  • + {{ $name }} + {{- with .Children }} + + {{- end }} +
  • + {{- end }} +{{- end }} diff --git a/layouts/partials/sidebar/socials.html b/themes/own-theme/layouts/partials/socials.html similarity index 100% rename from layouts/partials/sidebar/socials.html rename to themes/own-theme/layouts/partials/socials.html diff --git a/themes/own-theme/layouts/partials/terms.html b/themes/own-theme/layouts/partials/terms.html new file mode 100644 index 0000000..8a6ebec --- /dev/null +++ b/themes/own-theme/layouts/partials/terms.html @@ -0,0 +1,23 @@ +{{- /* +For a given taxonomy, renders a list of terms assigned to the page. + +@context {page} page The current page. +@context {string} taxonomy The taxonomy. + +@example: {{ partial "terms.html" (dict "taxonomy" "tags" "page" .) }} +*/}} + +{{- $page := .page }} +{{- $taxonomy := .taxonomy }} + +{{- with $page.GetTerms $taxonomy }} + {{- $label := (index . 0).Parent.LinkTitle }} +
    +
    {{ $label }}:
    + +
    +{{- end }} diff --git a/themes/own-theme/static/favicon.ico b/themes/own-theme/static/favicon.ico new file mode 100644 index 0000000..67f8b77 Binary files /dev/null and b/themes/own-theme/static/favicon.ico differ diff --git a/themes/own-theme/theme.toml b/themes/own-theme/theme.toml new file mode 100644 index 0000000..c04ec33 --- /dev/null +++ b/themes/own-theme/theme.toml @@ -0,0 +1,31 @@ +name = 'the theme' +# license = '' +# licenselink = 'https://github.com/owner/repo/LICENSE' +# description = 'Theme description' +# +# # The home page of the theme, where the source can be found +# homepage = 'https://github.com/owner/repo' +# +# # If you have a running demo of the theme +# demosite = 'https://owner.github.io/repo' +# +# # Taxonomy terms +# tags = ['blog', 'company'] +# features = ['some', 'awesome', 'features'] +# +# # If the theme has multiple authors +# authors = [ +# {name = 'Name of author', homepage = 'Website of author'}, +# {name = 'Name of author', homepage = 'Website of author'} +# ] +# +# # If the theme has a single author +# [author] +# name = 'Your name' +# homepage = 'Your website' +# +# # If porting an existing theme +# [original] +# author = 'Name of original author' +# homepage = 'Website of original author' +# repo = 'https://github.com/owner/repo'