From: Jannik ZANDER Date: Tue, 9 Sep 2025 19:13:50 +0000 (+0200) Subject: Readme X-Git-Url: https://git.zndr.dk/?a=commitdiff_plain;h=b8839990d62a0b4fd18069f31e7d9319a3c3bab9;p=zndr-11ty.git Readme --- diff --git a/README.md b/README.md new file mode 100644 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 + diff --git a/site/_includes/layouts/base.njk b/site/_includes/layouts/base.njk index b25725d..ab79450 100644 --- a/site/_includes/layouts/base.njk +++ b/site/_includes/layouts/base.njk @@ -46,7 +46,7 @@ {% endblock %}