compile: static site generator

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..08d3f1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Minimal Obsidian blog
+
+Write posts as flat Markdown files directly in `posts/`, then build the static site:
+
+```sh
+./bin/compile
+```
+
+The generated site is placed in `bld/`; open `bld/index.html` in any browser or publish that directory. No JavaScript or third-party build dependency is used.
+
+## Posts
+
+Use Obsidian-compatible YAML front matter. `title` is optional when the note starts with a level-one heading. `date` and `tags` are used to make the lists. Inline Obsidian tags such as `#writing` are collected too.
+
+```markdown
+---
+title: A small beginning
+date: 2026-08-29 09:30
+tags: [notes, writing]
+---
+
+The post body, which may also contain #ideas.
+```
+
+Post filenames become URLs, for example `posts/a-small-beginning.md` produces `bld/a-small-beginning.html`. Keep `posts/` flat. Files in `posts/` that are not Markdown (images, PDFs, and so on) are copied unchanged to `bld/`.
+
+## Constant pages
+
+Put Markdown files such as `about.md` or `contact.md` in `pages/`. They build to the root of `bld/` and appear as small links on every index/tag list page. This keeps permanent information available without mixing it into post chronology.
+
+## Typography
+
+The stylesheet uses **Libre Baskerville**, the serif typeface used by the requested Commoncog reference page, with Baskerville/Georgia fallbacks. It is loaded from Google Fonts; browsers without network access retain the local fallbacks.