site source

2025-01-27 22:16:57 +11:00 · 2025-01-27 22:16:57 +11:00 · 5fe2440107
commit 5fe2440107
parent 6076d5a2b4
24 changed files with 328 additions and 0 deletions
--- a/204
+++ b/204
@ -0,0 +1,204 @@
+#!/usr/bin/make -f
+
+BLOG := $(MAKE) -f $(lastword $(MAKEFILE_LIST)) --no-print-directory
+ifneq ($(filter-out help,$(MAKECMDGOALS)),)
+include config
+endif
+
+# The following can be configured in config
+BLOG_DATE_FORMAT_INDEX ?= %x
+BLOG_DATE_FORMAT ?= %x %X
+BLOG_TITLE ?= blog
+BLOG_DESCRIPTION ?= blog
+BLOG_URL_ROOT ?= http://localhost/blog
+BLOG_FEED_MAX ?= 20
+BLOG_FEEDS ?= rss atom
+BLOG_SRC ?= articles
+
+
+.PHONY: help init build deploy clean
+
+ARTICLES = $(shell git ls-tree HEAD --name-only -- $(BLOG_SRC)/ 2>/dev/null)
+TAGFILES = $(patsubst $(BLOG_SRC)/%.md,tags/%,$(ARTICLES))
+
+help:
+	$(info blogit init|build|deploy|clean)
+
+init:
+	mkdir -p $(BLOG_SRC) data templates
+	printf '<!DOCTYPE html><html><head><title>$$TITLE</title><meta charset="UTF-8"/><link rel="alternate" href="atom.xml" type="application/atom+xml" title="Atom feed"/><style>body{font-family:monospace;margin:40px auto;max-width:650px;line-height:1.6;font-size:18px;color:#d9d9d9;background-color:#000;padding:0 10px}html a{color:#00a2e7}html a:visited {color:#ca1a70}h1,h2,h3{line-height:1.2}</style></head><body>' > templates/header.html
+	printf '</body></html>' > templates/footer.html
+	printf '<header><h1>will holdsworth'\''s blog</h1><nav><p><br></p></nav></header><body>' > templates/index_header.html
+	printf '<p>tags: ' > templates/tag_list_header.html
+	printf '<a href="$$URL">#$$NAME</a>' > templates/tag_entry.html
+	printf ', ' > templates/tag_separator.html
+	printf '</p>' > templates/tag_list_footer.html
+	printf '<h2>posts</h2><ul>' > templates/article_list_header.html
+	printf '<li>$$DATE - <a href="$$URL">$$TITLE</a></li>' > templates/article_entry.html
+	printf '' > templates/article_separator.html
+	printf '</ul>' > templates/article_list_footer.html
+	printf '<p><br></p></body><footer><hr>feeds: <a href="atom.xml">atom</a>, <a href="rss.xml">rss</a></footer>' > templates/index_footer.html
+	printf '<header><h1>#$$TAGS</h1><nav><a href="index.html">← all posts</a></header></nav><body>' > templates/tag_index_header.html
+	printf '</body>' > templates/tag_index_footer.html
+	printf '<header><h1>will holdsworth'\''s blog</h1><nav><a href="index.html">← all posts</a></nav></header><body><h2>$$TITLE</h2><p><i>posted: $$DATE_POSTED<br>edited: $$DATE_EDITED</i></p>' > templates/article_header.html
+	printf '<p><br></p></body><footer><hr>tags: $$TAGS</footer>' > templates/article_footer.html
+	printf 'blog\n' > .git/info/exclude
+
+build: blog/index.html tagpages $(patsubst $(BLOG_SRC)/%.md,blog/%.html,$(ARTICLES)) $(patsubst %,blog/%.xml,$(BLOG_FEEDS))
+
+deploy: build
+	rsync -rLtvz $(BLOG_RSYNC_OPTS) blog/ data/ $(BLOG_REMOTE)
+
+clean:
+	rm -rf blog tags
+
+config:
+	printf 'BLOG_REMOTE:=%s\n' \
+		'$(shell printf "Blog remote (eg: host:/var/www/html): ">/dev/tty; head -n1)' \
+		> $@
+
+tags/%: $(BLOG_SRC)/%.md
+	mkdir -p tags
+	grep -i '^; *tags:' "$<" | cut -d: -f2- | sed 's/  */\n/g' | sed '/^$$/d' | sort -u > $@
+
+blog/index.html: $(ARTICLES) $(TAGFILES) $(addprefix templates/,$(addsuffix .html,header index_header tag_list_header tag_entry tag_separator tag_list_footer article_list_header article_entry article_separator article_list_footer index_footer footer))
+	mkdir -p blog
+	TITLE="$(BLOG_TITLE)"; \
+	export TITLE; \
+	envsubst < templates/header.html > $@; \
+	envsubst < templates/index_header.html >> $@; \
+	envsubst < templates/tag_list_header.html >> $@; \
+	first=true; \
+	for t in $(shell cat $(TAGFILES) | sort -u); do \
+		"$$first" || envsubst < templates/tag_separator.html; \
+		NAME="$$t" \
+		URL="@$$t.html" \
+		envsubst < templates/tag_entry.html; \
+		first=false; \
+	done >> $@; \
+	envsubst < templates/tag_list_footer.html >> $@; \
+	envsubst < templates/article_list_header.html >> $@; \
+	first=true; \
+	for f in $(ARTICLES); do \
+		printf '%s ' "$$f"; \
+		git log --diff-filter=A --date="format:%s $(BLOG_DATE_FORMAT_INDEX)" --pretty=format:'%ad%n' -- "$$f"; \
+	done | sort -k2nr | cut -d" " -f1,3- | while IFS=" " read -r FILE DATE; do \
+		"$$first" || envsubst < templates/article_separator.html; \
+		URL="`printf '%s' "\$$FILE" | sed 's,^$(BLOG_SRC)/\(.*\).md,\1,'`.html" \
+		DATE="$$DATE" \
+		TITLE="`head -n1 "\$$FILE" | sed -e 's/^# //g'`" \
+		envsubst < templates/article_entry.html; \
+		first=false; \
+	done >> $@; \
+	envsubst < templates/article_list_footer.html >> $@; \
+	envsubst < templates/index_footer.html >> $@; \
+	envsubst < templates/footer.html >> $@; \
+
+
+blog/tag/%.html: $(ARTICLES) $(addprefix templates/,$(addsuffix .html,header tag_header index_entry tag_footer footer))
+
+.PHONY: tagpages
+tagpages: $(TAGFILES)
+	+$(BLOG) $(patsubst %,blog/@%.html,$(shell cat $(TAGFILES) | sort -u))
+
+blog/@%.html: $(TAGFILES) $(addprefix templates/,$(addsuffix .html,header tag_index_header tag_list_header tag_entry tag_separator tag_list_footer article_list_header article_entry article_separator article_list_footer tag_index_footer footer))
+	mkdir -p blog
+	TITLE="Articles tagged $*"; \
+	TAGS="$*"; \
+	export TITLE; \
+	export TAGS; \
+	envsubst < templates/header.html > $@; \
+	envsubst < templates/tag_index_header.html >> $@; \
+	envsubst < templates/article_list_header.html >> $@; \
+	first=true; \
+	for f in $(shell grep -FH '$*' $(TAGFILES) | sed 's,^tags/\([^:]*\):.*,$(BLOG_SRC)/\1.md,'); do \
+		printf '%s ' "$$f"; \
+		git log --diff-filter=A --date="format:%s $(BLOG_DATE_FORMAT_INDEX)" --pretty=format:'%ad%n' -- "$$f"; \
+	done | sort -k2nr | cut -d" " -f1,3- | while IFS=" " read -r FILE DATE; do \
+		"$$first" || envsubst < templates/article_separator.html; \
+		URL="`printf '%s' "\$$FILE" | sed 's,^$(BLOG_SRC)/\(.*\).md,\1,'`.html" \
+		DATE="$$DATE" \
+		TITLE="`head -n1 "\$$FILE" | sed -e 's/^# //g'`" \
+		envsubst < templates/article_entry.html; \
+		first=false; \
+	done >> $@; \
+	envsubst < templates/article_list_footer.html >> $@; \
+	envsubst < templates/tag_index_footer.html >> $@; \
+	envsubst < templates/footer.html >> $@; \
+
+
+blog/%.html: $(BLOG_SRC)/%.md $(addprefix templates/,$(addsuffix .html,header article_header article_footer footer))
+	mkdir -p blog
+	TITLE="$(shell head -n1 $<)"; \
+	export TITLE; \
+	AUTHOR="$(shell git log -n 1 --reverse --format="%cn" -- "$<")"; \
+	export AUTHOR; \
+	DATE_POSTED="$(shell git log --diff-filter=A --date="format:$(BLOG_DATE_FORMAT)" --pretty=format:'%ad' -- "$<")"; \
+	export DATE_POSTED; \
+	DATE_EDITED="$(shell git log -n 1 --date="format:$(BLOG_DATE_FORMAT)" --pretty=format:'%ad' -- "$<")"; \
+	export DATE_EDITED; \
+	TAGS="$(shell grep -i '^; *tags:' "$<" | cut -d: -f2- | paste -sd ',')"; \
+	export TAGS; \
+	envsubst < templates/header.html > $@; \
+	envsubst < templates/article_header.html >> $@; \
+	sed -e 1d \
+		-e '/^;/d' \
+		-e 's/&/\&amp;/g' \
+		-e 's/</\&lt;/g' \
+		-e 's/>/\&gt;/g' \
+		-e '/^```$$/{s,.*,,;x;p;/^<\/code>/d;s,.*,<pre><code>,;bT}' \
+		-e 'x;/<\/code>/{x;s,\$$,\&#36;,g;$$G;p;d};x' \
+		-e 's,\\\$$,\&#36;,g' \
+		-e '/^####/{s,^####,<h4>,;s,$$,</h4>,;H;s,.*,,;x;p;d}' \
+		-e '/^###/{s,^###,<h3>,;s,$$,</h3>,;H;s,.*,,;x;p;d}' \
+		-e '/^##/{s,^##,<h2>,;s,$$,</h2>,;H;s,.*,,;x;p;d}' \
+		-e '/^#/{s,^#,<h1>,;s,$$,</h1>,;H;s,.*,,;x;p;d}' \
+		-e 's,`\([^`]*\)`,<code>\1</code>,g' \
+		-e 's,\*\*\(\([^*<>][^*<>]*\*\?\)*\)\*\*,<b>\1</b>,g' \
+		-e 's,\*\([^*<>][^*<>]*\)\*,<i>\1</i>,g' \
+		-e 's,!\[\([^]]*\)\](\([^)]*\)),<img src="\2" alt="\1"/>,g' \
+		-e 's,\[\([^]]*\)\](\([^)]*\)),<a href="\2">\1</a>,g' \
+		-e '/^- /{s,^- ,<li>,;s,$$,</li>,;x;/^<\/ul>/{x;bL};p;s,.*,<ul>,;bT}' \
+		-e '/^[1-9][0-9]*\. /{s,^[0-9]*\. ,<li>,;s,$$,</li>,;x;/^<\/ol>/{x;bL};p;s,.*,<ol>,;bT}' \
+		-e '/^$$/{x;/^$$/d;p;d}' \
+		-e 'x;/^$$/{s,.*,<p>,;bT};x' \
+		-e ':L;$$G;p;d' \
+		-e ':T;p;:t;s,<\([^/>][^>]*\)>\(\(<[^/>][^>]*>\)*\),\2</\1>,;/<[^\/>]/bt;x;/^$$/{$${x;p};d};bL' \
+		"$<" | envsubst >> $@; \
+	envsubst < templates/article_footer.html >> $@; \
+	envsubst < templates/footer.html >> $@; \
+
+blog/rss.xml: $(ARTICLES)
+	printf '<?xml version="1.0" encoding="UTF-8"?>\n<rss version="2.0">\n<channel>\n<title>%s</title>\n<link>%s</link>\n<description>%s</description>\n' \
+		"$(BLOG_TITLE)" "$(BLOG_URL_ROOT)" "$(BLOG_DESCRIPTION)" > $@
+	for f in $(ARTICLES); do \
+		printf '%s ' "$$f"; \
+		git log --diff-filter=A --date="format:%s %a, %d %b %Y %H:%M:%S %z" --pretty=format:'%ad%n' -- "$$f"; \
+	done | sort -k2nr | head -n $(BLOG_FEED_MAX) | cut -d" " -f1,3- | while IFS=" " read -r FILE DATE; do \
+		printf '<item>\n<title>%s</title>\n<link>%s</link>\n<guid>%s</guid>\n<pubDate>%s</pubDate>\n<description>%s</description>\n</item>\n' \
+			"`head -n 1 $$FILE`" \
+			"$(BLOG_URL_ROOT)/`basename $$FILE .md`.html" \
+			"$(BLOG_URL_ROOT)/`basename $$FILE .md`.html" \
+			"$$DATE" \
+			"`sed -n '1d;/^$$/{2{d;b};q};p' < $$FILE`"; \
+	done >> $@
+	printf '</channel>\n</rss>\n' >> $@
+
+blog/atom.xml: $(ARTICLES)
+	printf '<?xml version="1.0" encoding="UTF-8"?>\n<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en">\n<title type="text">%s</title>\n<subtitle type="text">%s</subtitle>\n<updated>%s</updated>\n<link rel="alternate" type="text/html" href="%s"/>\n<id>%s</id>\n<link rel="self" type="application/atom+xml" href="%s"/>\n' \
+		"$(BLOG_TITLE)" "$(BLOG_DESCRIPTION)" "$(shell date +%Y-%m-%dT%H:%M:%SZ)" "$(BLOG_URL_ROOT)" "$(BLOG_URL_ROOT)/atom.xml" "$(BLOG_URL_ROOT)/atom.xml" > $@
+	for f in $(ARTICLES); do \
+		printf '%s ' "$$f"; \
+		git log --diff-filter=A --date="format:%s %Y-%m-%dT%H:%M:%SZ" --pretty=format:'%ad %aN%n' -- "$$f"; \
+	done | sort -k2nr | head -n $(BLOG_FEED_MAX) | cut -d" " -f1,3- | while IFS=" " read -r FILE DATE AUTHOR; do \
+		printf '<entry>\n<title type="text">%s</title>\n<link rel="alternate" type="text/html" href="%s"/>\n<id>%s</id>\n<published>%s</published>\n<updated>%s</updated>\n<author><name>%s</name></author>\n<summary type="text">%s</summary>\n</entry>\n' \
+			"`head -n 1 $$FILE`" \
+			"$(BLOG_URL_ROOT)/`basename $$FILE .md`.html" \
+			"$(BLOG_URL_ROOT)/`basename $$FILE .md`.html" \
+			"$$DATE" \
+			"`git log -n 1 --date="format:%Y-%m-%dT%H:%M:%SZ" --pretty=format:'%ad' -- "$$FILE"`" \
+			"$$AUTHOR" \
+			"`sed -n '1d;/^$$/{2{d;b};q};p' < $$FILE`"; \
+	done >> $@
+	printf '</feed>\n' >> $@
+
--- a/articles/welcome.md
+++ b/articles/welcome.md
@ -0,0 +1,18 @@
+welcome!
+
+the static site generator i'm using to kickstart this blog[1] requires a single post to exist in order to compile, and failing to provide a post sends `make` into an infinite loop.
+
+so without further ado here it is, my first post!
+
+topics to expect once i get myself more organised:
+
+- basic tutorials on setting up self-hosted nixos web services
+- lazy hardware reviews
+- software shenanigans
+- anything else i feel is relevant and useful to the wider web
+
+thanks for stopping by ^.^
+
+[1] [blogit](https://pedantic.software/git/blogit) 
+
+;tags: all
--- a/7
+++ b/7
@ -0,0 +1,7 @@
+BLOG_REMOTE:=opal:/srv/fi33buzz
+BLOG_DATE_FORMAT:=%Y/%m/%d %H:%M
+BLOG_DATE_FORMAT_INDEX:=%Y/%m/%d
+BLOG_TITLE:=will holdsworth's blog
+BLOG_URL_ROOT:=https://fi33.buzz
+BLOG_FEED_MAX:=20
+BLOG_FEEDS:=rss atom
--- a/flake.lock
+++ b/flake.lock
@ -0,0 +1,57 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 0,
+        "narHash": "sha256-nmKOgAU48S41dTPIXAq0AHZSehWUn6ZPrUKijHAMmIk=",
+        "path": "/nix/store/irknf7niks2djxz4csh7sr44wwrs082y-source",
+        "type": "path"
+      },
+      "original": {
+        "id": "nixpkgs",
+        "type": "indirect"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}
--- a/flake.nix
+++ b/flake.nix
@ -0,0 +1,16 @@
+{
+  inputs.flake-utils.url = "github:numtide/flake-utils";
+
+  outputs = { 
+    nixpkgs, 
+    flake-utils,
+    ...
+  }:
+    flake-utils.lib.eachDefaultSystem
+      (system:
+        let pkgs = nixpkgs.legacyPackages.${system}; in
+        {
+          devShells.default = import ./shell.nix { inherit pkgs; };
+        }
+      );
+}
--- a/shell.nix
+++ b/shell.nix
@ -0,0 +1,8 @@
+{ pkgs ? import <nixpkgs> {} }:
+  pkgs.mkShell {
+    nativeBuildInputs = with pkgs.buildPackages; [ 
+      gnumake 
+      envsubst 
+      python312Packages.mat2
+    ];
+}
--- a/tags/test
+++ b/tags/test
@ -0,0 +1,2 @@
+test1
+test2
--- a/tags/welcome
+++ b/tags/welcome
@ -0,0 +1 @@
+all
--- a/templates/article_entry.html
+++ b/templates/article_entry.html
@ -0,0 +1 @@
+<li>$DATE - <a href="$URL">$TITLE</a></li>
--- a/templates/article_footer.html
+++ b/templates/article_footer.html
@ -0,0 +1 @@
+<p><br></p></body><footer><hr>tags: $TAGS</footer>
--- a/templates/article_header.html
+++ b/templates/article_header.html
@ -0,0 +1 @@
+<header><h1>will holdsworth's blog</h1><nav><a href="index.html">← all posts</a></nav></header><body><h2>$TITLE</h2><p><i>posted: $DATE_POSTED<br>edited: $DATE_EDITED</i></p>
--- a/templates/article_list_footer.html
+++ b/templates/article_list_footer.html
@ -0,0 +1 @@
+</ul>
--- a/templates/article_list_header.html
+++ b/templates/article_list_header.html
@ -0,0 +1 @@
+<h2>posts</h2><ul>
--- a/templates/article_separator.html
+++ b/templates/article_separator.html
--- a/templates/footer.html
+++ b/templates/footer.html
@ -0,0 +1 @@
+</body></html>
--- a/templates/header.html
+++ b/templates/header.html
@ -0,0 +1 @@
+<!DOCTYPE html><html><head><title>$TITLE</title><meta charset="UTF-8"/><link rel="alternate" href="atom.xml" type="application/atom+xml" title="Atom feed"/><style>body{font-family:monospace;margin:40px auto;max-width:650px;line-height:1.6;font-size:18px;color:#d9d9d9;background-color:#000;padding:0 10px}html a{color:#00a2e7}html a:visited {color:#ca1a70}h1,h2,h3{line-height:1.2}</style></head><body>
--- a/templates/index_footer.html
+++ b/templates/index_footer.html
@ -0,0 +1 @@
+<p><br></p></body><footer><hr>feeds: <a href="atom.xml">atom</a>, <a href="rss.xml">rss</a></footer>
--- a/templates/index_header.html
+++ b/templates/index_header.html
@ -0,0 +1 @@
+<header><h1>will holdsworth's blog</h1><nav><p><br></p></nav></header><body>
--- a/templates/tag_entry.html
+++ b/templates/tag_entry.html
@ -0,0 +1 @@
+<a href="$URL">#$NAME</a>
--- a/templates/tag_index_footer.html
+++ b/templates/tag_index_footer.html
@ -0,0 +1 @@
+</body>
--- a/templates/tag_index_header.html
+++ b/templates/tag_index_header.html
@ -0,0 +1 @@
+<header><h1>#$TAGS</h1><nav><a href="index.html">← all posts</a></header></nav><body>
--- a/templates/tag_list_footer.html
+++ b/templates/tag_list_footer.html
@ -0,0 +1 @@
+</p>
--- a/templates/tag_list_header.html
+++ b/templates/tag_list_header.html
@ -0,0 +1 @@
+<p>tags: 
--- a/templates/tag_separator.html
+++ b/templates/tag_separator.html
@ -0,0 +1 @@
+,
				`@ -0,0 +1 @@`
				`<p><br></p></body><footer><hr>tags: $TAGS</footer>`
				`@ -0,0 +1 @@`
				`<header><h1>will holdsworth's blog</h1><nav><a href="index.html">← all posts</a></nav></header><body><h2>$TITLE</h2><p><i>posted: $DATE_POSTED<br>edited: $DATE_EDITED</i></p>`
				`@ -0,0 +1 @@`
				`<!DOCTYPE html><html><head><title>$TITLE</title><meta charset="UTF-8"/><link rel="alternate" href="atom.xml" type="application/atom+xml" title="Atom feed"/><style>body{font-family:monospace;margin:40px auto;max-width:650px;line-height:1.6;font-size:18px;color:#d9d9d9;background-color:#000;padding:0 10px}html a{color:#00a2e7}html a:visited {color:#ca1a70}h1,h2,h3{line-height:1.2}</style></head><body>`
				`@ -0,0 +1 @@`
				`<p><br></p></body><footer><hr>feeds: <a href="atom.xml">atom</a>, <a href="rss.xml">rss</a></footer>`
				`@ -0,0 +1 @@`
				`<header><h1>#$TAGS</h1><nav><a href="index.html">← all posts</a></header></nav><body>`