From ee0a0c91a11e823729180e44e45a2f8b0e9c7f26 Mon Sep 17 00:00:00 2001 From: Lyn Fugmann Date: Mon, 30 Sep 2024 19:37:22 +0200 Subject: [PATCH] add docs for editing the content --- README.md | 7 +++++++ content/_data/program.md | 19 +++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 content/_data/program.md diff --git a/README.md b/README.md index a39154e..1b2a565 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ This is the WIP rewrite of the ESE website. +## Editing the content +All content is in the `content` directory, in the form of markdown files. There usually no need to install/build the project in order to make changes there. + +Additionally, there are some data files in `content/_data`: +- `ese.yaml`: the year and color is configured here +- `program.yaml`: see [it's documentation](content/_data/program.md) + ## Building To build the website, install the dependencies and run the build script: diff --git a/content/_data/program.md b/content/_data/program.md new file mode 100644 index 0000000..83057c1 --- /dev/null +++ b/content/_data/program.md @@ -0,0 +1,19 @@ +# program.yaml + +The top level keys must be a *quoted date in yyyy-mm-dd format*. + +Each contains a list of events, which have the following properties: +- `start`: time in hh:mm +- `end`: time or null/omit if open ended +- `title`, `description`, `location`, `annotation`: either de/en versions (like this [^1]) or simply a string if it should be the same for all languages. + - `description`, `location` and `annotation` can use some markdown, e.g. hyperlinks or bold text + - `location` and `annotation` can be omitted. +- `checkin_link`: optionally, a url where people need to register or can find more important information +- `livestream`: true, if this event will be live streamed. Can be omitted otherwise. + +[^1]: ```yaml + title: + de: Begrüßung + en: Grand Opening + ``` + Both en and de versions must be set and non-empty.