blob: a914f512a798e072c93162d4ea08566daa8f6132 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# mediocre-caddy-plugins
TODO proper introduction
## Build
TODO
## Plugins
The following plugins are implemented in this module.
### http.handlers.templates.functions.gemtext
This extension to `templates` allows for rendering a [gemtext][gemtext] string
as a roughly equivalent set of HTML tags. It is similar to the [markdown template
function][mdfunc] in its usage. It can be enabled by being included in the
`templates.extensions` set.
```text
templates {
extensions {
gemtext
}
}
```
Within a template being rendered the `gemtext` function will be available and
can be passed any string. The function will return a struct with the following
fields:
* `Body`: The result of converting each line of the input string into an
equivalent line of HTML. This will not include any wrapping HTML tags like
`<div>` or `<body>`.
* `Title`: A suggested title, based on the first `# Header` line found in the
gemtext input.
See the `template.localhost` virtual host in `example/Caddyfile`, and the
associated `example/tpl/render_gemtext.html` template file, for an example of
how to use the template function.
[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
```
The `./cmd/mediocre-caddy` binary package can be used to run a Caddy instance
with all plugins provided by this package pre-installed.
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
```
|
