lfk/document-server
2
0
Fork 0
Code Issues 2 Pull Requests Actions Projects Releases 13 Wiki Activity

Updated readme for handlebars

Browse Source 
ref #5
This commit is contained in:
Nicolai Ort 2021-02-05 21:29:21 +01:00
parent 6f81566cb8
commit 05e471878f
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -37,7 +37,7 @@ The basic generation mechanism makes the templates and routes interchangeable (i
> The templates are stored in src/templates by default. > The templates are stored in src/templates by default.
We provide a set of default templates that we use for the ["Lauf für Kaya!" charity run](https://lauf-fuer-kaya.de). We provide a set of default templates that we use for the ["Lauf für Kaya!" charity run](https://lauf-fuer-kaya.de).
We use mustache-style templating strings to fill the templates with real information (exact strings are explained below). We use handlebars for templateing utilizing i18next for translation.
You can provide your own templates by replacing the ones we provided before compiling the project or by simply mounting your custom templates into the docker container. You can provide your own templates by replacing the ones we provided before compiling the project or by simply mounting your custom templates into the docker container.
The server currently needs the following templates to work: The server currently needs the following templates to work:
@ -45,12 +45,9 @@ The server currently needs the following templates to work:
### Sponsoring Contracts ### Sponsoring Contracts
| Template String | Type | Optional | Description | Template Data | Type | Optional | Description
| - | - | - | - | - | - | - | -
| runner_firstname | string | ❌ | The runner's first name | runner | object(Runner) | ❌ | The runner object.
| runner_middlename | string | ✅ | The runner's middle name
| runner_lastname | string | ❌ | The runner's last name
| runner_id | int | ❌ | The runner's id
## Recommended Editor ## Recommended Editor