markdown/doc.go

/*
A translation of peg-markdown [1] into Go.

Usage example:

	package main

	import (
		"github.com/knieriem/markdown"
		"os"
		"bufio"
	)

	func main() {
		p := markdown.NewParser(&markdown.Extensions{Smart: true})

		w := bufio.NewWriter(os.Stdout)
		p.Markdown(os.Stdin, markdown.ToHTML(w))
		w.Flush()
	}

[1]: https://github.com/jgm/peg-markdown/
*/
package markdown
initial import 2010-11-21 22:04:39 +00:00			`/*`
			`A translation of peg-markdown [1] into Go.`

			`Usage example:`

Parse: take an io.Reader argument instead of a string 2012-04-20 23:19:46 +00:00			`package main`

initial import 2010-11-21 22:04:39 +00:00			`import (`
new API: p := NewParser(&opts), p.Markdown(r, f) replaces d := Parse(r, opts), d.WriteHtml(w) The new api allows to create a parser instance that can be reused between calls to Markdown. Also, an interface `Formatter' replaces the tight coupling between former Doc type and HTML generation. 2012-04-28 20:57:55 +00:00			`"github.com/knieriem/markdown"`
initial import 2010-11-21 22:04:39 +00:00			`"os"`
			`"bufio"`
			`)`

			`func main() {`
rename: Options -> Extensions 2012-05-04 14:20:29 +00:00			`p := markdown.NewParser(&markdown.Extensions{Smart: true})`
initial import 2010-11-21 22:04:39 +00:00
			`w := bufio.NewWriter(os.Stdout)`
new API: p := NewParser(&opts), p.Markdown(r, f) replaces d := Parse(r, opts), d.WriteHtml(w) The new api allows to create a parser instance that can be reused between calls to Markdown. Also, an interface `Formatter' replaces the tight coupling between former Doc type and HTML generation. 2012-04-28 20:57:55 +00:00			`p.Markdown(os.Stdin, markdown.ToHTML(w))`
initial import 2010-11-21 22:04:39 +00:00			`w.Flush()`
			`}`

			`[1]: https://github.com/jgm/peg-markdown/`
			`*/`
			`package markdown`