]> git.zndr.dk Git - zndr-11ty.git/commitdiff
Readme
authorJannik ZANDER <jzander@grundfos.com>
Tue, 9 Sep 2025 19:13:50 +0000 (21:13 +0200)
committerJannik ZANDER <jzander@grundfos.com>
Tue, 9 Sep 2025 19:13:50 +0000 (21:13 +0200)
README.md [new file with mode: 0644]
site/_includes/layouts/base.njk

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e985c5c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+zndr.dk — Personal Website
+==========================
+
+Minimal static site for https://zndr.dk, built with Eleventy (11ty).
+
+------------------------------------------------------------
+Features
+------------------------------------------------------------
+- Dark-first theme with light-mode support
+- Brand accent color: green (#10a37f)
+- Pages:
+  /           — landing dashboard (cards + search/filter)
+  /blog/      — blog index (Markdown posts)
+  /blog/...   — blog posts
+  /about/     — about page
+- Assets:
+  zndr.svg    — favicon (stacked ZN/DR, tight fit)
+  zndr-app.svg — app icon (padded for Android/iOS masks)
+  pgp.txt and keys.txt — public PGP + SSH keys
+- Extras:
+  - Live card search on landing page, "/" to focus, Enter opens the only match
+  - Dynamic year in footer
+  - Responsive images in blog posts
+  - PWA manifest + favicons
+
+------------------------------------------------------------
+Development
+------------------------------------------------------------
+Build:
+  npm install
+  npm run build
+  Source: site/
+  Output: dist/
+
+Deploy:
+  npm run deploy
+  (syncs to /var/www/website/ on server)
+
+Dev server:
+  npx eleventy --serve --input=site --output=dist
+  Open http://localhost:8080
+
+------------------------------------------------------------
+Project Structure
+------------------------------------------------------------
+site/
+  assets/      CSS, images
+  blog/        Markdown posts
+  public/      Static passthrough (PGP, keys, icons, manifest)
+  _includes/   Layouts (base, blog, page)
+  _data/       Global data
+  index.njk    Landing page
+  about.md     About page
+
+------------------------------------------------------------
+Icons
+------------------------------------------------------------
+Generate favicons / app icons:
+  npm run build-icon
+
+- zndr.svg generates favicons (16px, 32px, ico, etc.)
+- zndr-app.svg generates app icons (Android, iOS, maskable)
+
+------------------------------------------------------------
+Future Enhancements
+------------------------------------------------------------
+- RSS feed for /blog/
+- Automated sitemap
+- Cache-busting build hash
+- Optional comments/webmentions
+
+------------------------------------------------------------
+© 2025 Jannik • Denmark
+
index b25725db2dc3caafbe94f23e3d4cec1b29d75c80..ab794505efa309d43cea0a56884bfd1e217c4cdf 100644 (file)
@@ -46,7 +46,7 @@
     {% endblock %}
 
     <footer>
-      <div>© {{ '' | year }} Jannik • Tange Sø</div>
+      <div>© {{ '' | year }} Jannik • Denmark</div>
       <div class="foot-links">
         <a href="/pgp.txt">PGP</a>
         <a href="/keys.txt">SSH Keys</a>