summaryrefslogtreecommitdiff
path: root/teleirc/matterbridge/vendor/github.com/gomarkdown/markdown/doc.go
diff options
context:
space:
mode:
authorMistivia <i@mistivia.com>2025-11-02 15:27:18 +0800
committerMistivia <i@mistivia.com>2025-11-02 15:27:18 +0800
commite9c24f4af7ed56760f6db7941827d09f6db9020b (patch)
tree62128c43b883ce5e3148113350978755779bb5de /teleirc/matterbridge/vendor/github.com/gomarkdown/markdown/doc.go
parent58d5e7cfda4781d8a57ec52aefd02983835c301a (diff)
add matterbridge
Diffstat (limited to 'teleirc/matterbridge/vendor/github.com/gomarkdown/markdown/doc.go')
-rw-r--r--teleirc/matterbridge/vendor/github.com/gomarkdown/markdown/doc.go35
1 files changed, 35 insertions, 0 deletions
diff --git a/teleirc/matterbridge/vendor/github.com/gomarkdown/markdown/doc.go b/teleirc/matterbridge/vendor/github.com/gomarkdown/markdown/doc.go
new file mode 100644
index 0000000..b623024
--- /dev/null
+++ b/teleirc/matterbridge/vendor/github.com/gomarkdown/markdown/doc.go
@@ -0,0 +1,35 @@
+/*
+Package markdown implements markdown parser and HTML renderer.
+
+It parses markdown into AST format which can be serialized to HTML
+(using html.Renderer) or possibly other formats (using alternate renderers).
+
+Convert markdown to HTML
+
+The simplest way to convert markdown document to HTML
+
+ md := []byte("## markdown document")
+ html := markdown.ToHTML(md, nil, nil)
+
+Customizing parsing and HTML rendering
+
+You can customize parser and HTML renderer:
+
+ import (
+ "github.com/gomarkdown/markdown/parser"
+ "github.com/gomarkdown/markdown/renderer"
+ "github.com/gomarkdown/markdown"
+ )
+ extensions := parser.CommonExtensions | parser.AutoHeadingIDs
+ p := parser.NewWithExtensions(extensions)
+
+ htmlFlags := html.CommonFlags | html.HrefTargetBlank
+ opts := html.RendererOptions{Flags: htmlFlags}
+ renderer := html.NewRenderer(opts)
+
+ md := []byte("markdown text")
+ html := markdown.ToHTML(md, p, renderer)
+
+For a cmd-line tool see https://github.com/gomarkdown/mdtohtml
+*/
+package markdown