diff --git a/.gitignore b/.gitignore index 008e122..03d9a0a 100644 --- a/.gitignore +++ b/.gitignore @@ -202,3 +202,8 @@ $RECYCLE.BIN/ *.lnk # End of https://www.toptal.com/developers/gitignore/api/windows,linux,macos,hugo,pycharm+all,vim,direnv + +### CCCB ### +# The calendar the site reads its events from is published next to the site and +# only downloaded here to look at the site locally, see the README. +/static/calendars/ diff --git a/README.md b/README.md index 0441f1c..977dbb3 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,17 @@ Every change you make on the project will be reflected in your browser as long a The *"Nächste Veranstaltungen"* table on the home page and the calendar under `/verein/calendar/` are rendered in the browser by `assets/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. +generated by Hugo and is not part of this repo — it is published separately on the web server. Without it both tables +stay empty. Download the published calendar into `static/`, which Hugo serves under the same path, and they work +locally, under `hugo serve` as well as in a built site: + +```shell +mkdir -p static/calendars +curl -o static/calendars/all.ics https://berlin.ccc.de/calendars/all.ics +``` + +The file is only there to look at the site, it is not checked in. Download it again whenever you want the events that +are currently published. 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/`.