klank-docs/README.md
2024-11-12 14:11:02 +01:00

19 lines
770 B
Markdown

# Klank docs
## installation
Run the install.sh to install [Mustache](https://github.com/tests-always-included/mo)
Also, pandoc is needed. Additionally researching this thing https://github.com/pandoc-ext/include-files/tree/main
More info to come ;)
## Scripts & folders
- `newsletters` write your new newsletter here
- `templates` contains a markdown template for events, that are being grabbed via
- `get_events.sh` run as `sh get_events.sh` to grab all events from the klankschool calendar and store them as markdwon files
- `install.sh` the installation script for Mustache
- `make_newsletter.sh` run as `sh make_newsletter` to translate all created newsletters in the `newsletters` directory into HTML. Created newsletters are stored in the `dist` directory