From e5d52c3e00171d2de5a6b1efbedf080ca07b3023 Mon Sep 17 00:00:00 2001 From: sermuns <sermuns@lysator.liu.se> Date: Tue, 29 Apr 2025 22:04:58 +0200 Subject: [PATCH] Update README, more explanations. --- README.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 413faeb..917620e 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,33 @@ -# Hemsida +# Lysators hemsida -Lysators hemsida! +## Projektstruktur -[`zola`](https://www.getzola.org/documentation/getting-started/overview/) används för att generera statiska html-sidor från markdown-innehåll. +Kort förklaring över de viktigaste filerna/katalogerna från roten av projektet: -`zola` använder ett templating-system som liknar Jinja, [`tera`](https://keats.github.io/tera/docs/). +```sh +├── config.toml # Global konfiguration för zola. +├── content # Alla markdown-filer. För det mesta behöver du bara pilla här! +├── sass # Global stil för hemsidan. sass-filer som kompileras till css. +├── static # Endast lätta bilder/typsnitt. Tyngre filer ligger direkt på webservern. +└── templates # HTML-templates som markdown-innehållet trycks genom. +``` -## Kom igång +All markdown, därmed brödtext, skrivs i `content`. -Använd gärna [`mise`](https://mise.jdx.dev/getting-started.html)! +## Utveckling -Efter att du har installerat `mise`: +[`zola`](https://www.getzola.org/documentation/getting-started/overview/) används för att generera HTML från markdown. Kan installeras på ett [flertal sätt](https://www.getzola.org/documentation/getting-started/installation/). -1. `mise trust` -2. `mise install` +För att köra en live-uppdaterande förhandsgranskning av hemsidan, kör: -Du har nu `zola` installerat, bara för denna miljö! +```sh +zola serve +``` -# Diskussion -Vi diskuterar vad som behövs göras, och trackar "TODO" i mattermost: <https://mattermost.lysator.liu.se/www>. Vill du ha tillgång? Kontakta sermuns: `sermuns@lysator.liu.se`. +Du kan nu gå till http://localhost:1111 för att se lokala tillståndet av hemsidan. -# TODO +För att bygga produktionsfärdig html, kör: -- [ ] fula scrollbars på chromium +```sh +zola build +``` -- GitLab