summaryrefslogtreecommitdiff
path: root/modules/caddyhttp
diff options
context:
space:
mode:
authorFrancis Lavoie <lavofr@gmail.com>2022-02-07 00:14:41 -0500
committerGitHub <noreply@github.com>2022-02-06 22:14:41 -0700
commit1d0425b26f1fbb797d7bc10e3740dc031410d01f (patch)
treedcb44fd053ec7fde08c6adc338324249b8d86772 /modules/caddyhttp
parent7557d1d92240d7dc36a6f8137ab542f3908f316c (diff)
templates: Elaborate on what's supported by the markdown function (#4564)
Diffstat (limited to 'modules/caddyhttp')
-rw-r--r--modules/caddyhttp/templates/templates.go6
1 files changed, 5 insertions, 1 deletions
diff --git a/modules/caddyhttp/templates/templates.go b/modules/caddyhttp/templates/templates.go
index f7332a9..d4505f0 100644
--- a/modules/caddyhttp/templates/templates.go
+++ b/modules/caddyhttp/templates/templates.go
@@ -126,7 +126,11 @@ func init() {
//
// ##### `markdown`
//
-// Renders the given Markdown text as HTML.
+// Renders the given Markdown text as HTML. This uses the
+// [Goldmark](https://github.com/yuin/goldmark) library,
+// which is CommonMark compliant. It also has these plugins
+// enabled: Github Flavored Markdown, Footnote and syntax
+// highlighting provided by [Chroma](https://github.com/alecthomas/chroma).
//
// ```
// {{markdown "My _markdown_ text"}}