1/*
2Package markdown implements markdown parser and HTML renderer.
3
4It parses markdown into AST format which can be serialized to HTML
5(using html.Renderer) or possibly other formats (using alternate renderers).
6
7Convert markdown to HTML
8
9The simplest way to convert markdown document to HTML
10
11 md := []byte("## markdown document")
12 html := markdown.ToHTML(md, nil, nil)
13
14Customizing parsing and HTML rendering
15
16You can customize parser and HTML renderer:
17
18 import (
19 "github.com/gomarkdown/markdown/parser"
20 "github.com/gomarkdown/markdown/renderer"
21 "github.com/gomarkdown/markdown"
22 )
23 extensions := parser.CommonExtensions | parser.AutoHeadingIDs
24 p := parser.NewWithExtensions(extensions)
25
26 htmlFlags := html.CommonFlags | html.HrefTargetBlank
27 opts := html.RendererOptions{Flags: htmlFlags}
28 renderer := html.NewRenderer(opts)
29
30 md := []byte("markdown text")
31 html := markdown.ToHTML(md, p, renderer)
32
33For a cmd-line tool see https://github.com/gomarkdown/mdtohtml
34*/
35package markdown