summaryrefslogtreecommitdiff
path: root/gemini/gemtext/htmlconv/convert.go
diff options
context:
space:
mode:
Diffstat (limited to 'gemini/gemtext/htmlconv/convert.go')
-rw-r--r--gemini/gemtext/htmlconv/convert.go6
1 files changed, 4 insertions, 2 deletions
diff --git a/gemini/gemtext/htmlconv/convert.go b/gemini/gemtext/htmlconv/convert.go
index 5028766..2af4eea 100644
--- a/gemini/gemtext/htmlconv/convert.go
+++ b/gemini/gemtext/htmlconv/convert.go
@@ -12,8 +12,10 @@ import (
//
// Templates can be provided to override the output for different line types.
// The templates supported are:
-// - "header" is called before any lines and is passed the full Document.
-// - "footer" is called after the lines and is passed the full Document.
+// - "header" is called before any lines and is passed the full Document. It should,
+// at a minimum, produce opening <html> and <body> tags.
+// - "footer" is called after the lines and is passed the full Document. It should,
+// at a minimum, provide closing </body> and </html> tags.
// - "textline" is called once per line of text and is passed a gemtext.TextLine.
// - "linkline" is called once per link line and is passed an object which wraps
// a gemtext.LinkLine but also supports a ValidatedURL() method returning a