package libasciidoc

import "github.com/bytesparadise/libasciidoc"

Package libasciidoc is an open source Go library that converts Asciidoc content into HTML.

Index ¶

• Variables
• func ConvertFileToHTML(ctx context.Context, filename string, output io.Writer, options ...renderer.Option) (map[string]interface{}, error)
• func ConvertToHTML(ctx context.Context, filename string, r io.Reader, output io.Writer, options ...renderer.Option) (map[string]interface{}, error)

Package Files ¶

libasciidoc.go

Variables ¶

var (
    // BuildCommit lastest build commit (set by Makefile)
    BuildCommit = ""
    // BuildTag if the `BuildCommit` matches a tag
    BuildTag = ""
    // BuildTime set by build script (set by Makefile)
    BuildTime = ""
)

func ConvertFileToHTML ¶ Uses

func ConvertFileToHTML(ctx context.Context, filename string, output io.Writer, options ...renderer.Option) (map[string]interface{}, error)

ConvertFileToHTML converts the content of the given filename into an HTML document. The conversion result is written in the given writer `output`, whereas the document metadata (title, etc.) (or an error if a problem occurred) is returned as the result of the function call.

func ConvertToHTML ¶ Uses

func ConvertToHTML(ctx context.Context, filename string, r io.Reader, output io.Writer, options ...renderer.Option) (map[string]interface{}, error)

ConvertToHTML converts the content of the given reader `r` into a full HTML document, written in the given writer `output`. Returns an error if a problem occurred

Directories ¶