package libasciidoc

import "github.com/bytesparadise/libasciidoc"

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

Index ¶

• Variables
• func Convert(r io.Reader, output io.Writer, config configuration.Configuration) (types.Metadata, error)
• func ConvertFile(output io.Writer, config configuration.Configuration) (types.Metadata, 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 Convert ¶ Uses

func Convert(r io.Reader, output io.Writer, config configuration.Configuration) (types.Metadata, error)

Convert converts the content of the given reader `r` into a full output document, written in the given writer `output`. Returns an error if a problem occurred. The default will be HTML5, but depends on the config.BackEnd value.

func ConvertFile ¶ Uses

func ConvertFile(output io.Writer, config configuration.Configuration) (types.Metadata, error)

ConvertFile converts the content of the given filename into an output 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. The output format is determined by config.Backend (HTML5 default).

Directories ¶