aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHenrique Dias <hacdias@gmail.com>2023-11-10 14:23:27 +0100
committerGitHub <noreply@github.com>2023-11-10 05:23:27 -0800
commitbcddd3bbbea1a64a3fa9d71254f143246116b5b3 (patch)
tree9954499e5a916a1b1a1b1f67d06656e832b4b871 /README.md
parenta068bd4dd4b5040bd7b8ac514b32d3141f882b8a (diff)
downloadsally-bcddd3bbbea1a64a3fa9d71254f143246116b5b3.tar.gz
feat: support for custom templates (#129)
Adds a `-templates` flag that can be used to provide an alternative directory with templates for Sally to use. The new templates override the default set embedded in Sally. This includes a new 404 template so that 404 errors use the same theme as the rest of the website. Additionally, for HTTP status >400, this also sets the Cache-Control header to discourage CDNs like Cloudflare from caching the page. Resolves #125, #18
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 77fcadf..21f76e1 100644
--- a/README.md
+++ b/README.md
@@ -71,3 +71,10 @@ use the `-yml` and `-port` flags.
```
$ sally -yml site.yaml -port 5000
```
+
+### Custom Templates
+
+You can provide your own custom templates. For this, create a directory with `.html`
+templates and provide it via the `-templates` flag. You only need to provide the
+templates you want to override. See [templates](./templates/) for the available
+templates.