diff --git a/README.md b/README.md index 5f72bd0..e7f7a22 100644 --- a/README.md +++ b/README.md @@ -29,20 +29,22 @@ This is the website of the CCCB. Every change you make on the project will be reflected in your browser as long as `hugo serve` is running. -The *"Nächste Veranstaltungen"* table on the home page is generated by post-processing in `./build.sh`, not by Hugo, so -it is **not** visible under `hugo serve`. To preview the fully built site (including the home-page calendar), or to -ready the site for upload, run: +The *"Nächste Veranstaltungen"* table on the home page and the calendar under `/verein/calendar/` are rendered in the +browser by `static/js/upcoming.js` and `assets/js/calendar.js`. Both fetch `/calendars/all.ics`, which is **not** +generated by Hugo and is not part of this repo — it is published separately on the web server. Locally those two +tables therefore stay empty; check them on the [staging site](https://staging.berlin.ccc.de/) instead. + +Hugo does generate an `.ics` feed per section (for example `/veranstaltungen/index.ics`) from the `dtstart`, `dtend` +and `rrule` front matter of the pages in `content/veranstaltungen/`, using the `.ics` templates under `layouts/`. + +To build the site for upload, run: ```shell ./build.sh -python3 -m http.server -d public 1313 ``` -`build.sh` replaces the `CALENDAR` placeholder in `index.html` with the upcoming-events table. It depends on Python -with the `icalendar`, `python-dateutil`, and `pytz` packages, plus a `de_DE.UTF-8` locale (used to format weekday -names). Inside `nix develop` these are provided automatically. - -To build with *nix*: `nix build '.?submodules=1#production-content'` +This deletes `public/` and runs `hugo` with the parameters from `.hugo-params`. To build with *nix* instead: +`nix build '.?submodules=1#production-content'` ## Making a change @@ -59,8 +61,7 @@ To build with *nix*: `nix build '.?submodules=1#production-content'` ## Nix stuff -- After entering the shell with `nix develop`, hugo is available and `hugo serve` should work -- Python including required packages will be available, so the `build.sh` should work without a venv +- After entering the shell with `nix develop`, hugo is available and `hugo serve` and `./build.sh` should work - You can build the staging and production builds with `nix build .#staging-content` and `nix build .#production-content` - Do not update the nixpkgs branch - 25.05 contains a newer hugo version that is incompatible with the theme (last