aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Picciano <me@mediocregopher.com>2024-07-03 12:41:06 +0200
committerBrian Picciano <me@mediocregopher.com>2024-07-03 12:41:06 +0200
commit8d0b8d388b31050468362710078feb39ece802ed (patch)
treec011fbc42e34b4b4c01ae0ced7aacfc3915030ee
parent7e1ecc4df44d20d2c9de1c8885ddc2c188062ef0 (diff)
README fixes
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2a146ba..092f348 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ as a roughly equivalent set of HTML tags. It is similar to the [markdown templat
function][mdfunc] in its usage. It can be enabled by being included in the
`templates.extensions` set.
-```
+```text
templates {
extensions {
gemtext
@@ -29,13 +29,14 @@ See the `template.localhost` virtual host in `example/Caddyfile` for an example
of using the `gemtext` template to render a gemtext file within an HTML file.
[gemtext]: https://geminiprotocol.net/docs/gemtext.gmi
+[mdfunc]: https://caddyserver.com/docs/modules/http.handlers.templates#markdown
## Development
A nix-based development environment is provided with the correct versions of all
development dependencies. It can be activated by doing:
-```
+```bash
nix-shell -A shell
```
@@ -46,6 +47,6 @@ The Caddyfile `./example/Caddyfile` can be used to spin up a Caddy instance with
various virtual-hosts predefined with usefule configurations for testing. See
that file for a description of the available virtual hosts.
-```
+```bash
go run ./cmd/mediocre-caddy run --config ./example/Caddyfile
```