more readme

This commit is contained in:
Tyrel Souza 2023-10-14 23:26:45 -04:00
parent 257b6cc155
commit 3ea0b6290d
No known key found for this signature in database
GPG Key ID: F3614B02ACBE438E
1 changed files with 10 additions and 1 deletions

View File

@ -45,8 +45,17 @@ links:
```
### example `template.html`
This is a jinja template (uses the rust crate minijinja) that has any variable in the `links.yaml` available as context variables.
Docs will come some day. TODO: Docs
[Example code Here](./templates/links/links.html)
### static dir
This is optional, but everything inside will be copied directly next to the `index.html` in the `links` directory
This is optional, but everything inside will be copied directly next to the `index.html` in the `links` directory, put things like css or avatar images here.
Debating on manually needing to specify a list of files in `config:` but not sold on that yet.
## Blog - Coming Soon