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

Updated readme

Browse Source 
ref #5
This commit is contained in:
Nicolai Ort 2021-02-05 22:23:48 +01:00
parent 8ec5de4877
commit f69e7779e4
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
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.
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 handlebars for templateing utilizing i18next for translation.
We use handlebars for templateing utilizing i18next for translation - the i18n string format in the templates is : `{{__ "string"}}`
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:
@ -47,7 +47,8 @@ The server currently needs the following templates to work:
| Template Data | Type | Optional | Description
| - | - | - | -
| runner | object(Runner) | ❌ | The runner object.
| runners | array(Runner) | ❌ | The runner objects. We generate a contract for each runner on a new DIN-A5 page.
## Recommended Editor
@ -56,6 +57,7 @@ The server currently needs the following templates to work:
### Recommended Extensions
* will be automatically recommended via ./vscode/extensions.json
* we also provide a config for i18n-ally in the .vscode folder
## Staging
### Branches & Tags