add docs for editing the content
This commit is contained in:
parent
2fbd7a578a
commit
bc4aa830d5
|
@ -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 is 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:
|
||||
|
|
19
content/_data/program.md
Normal file
19
content/_data/program.md
Normal file
|
@ -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 italics
|
||||
- `location` and `annotation` are optional.
|
||||
- `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.
|
Loading…
Reference in a new issue