output

package

v0.0.0-...-852e987 Latest Latest Go to latest Published: Feb 1, 2018 License: MIT Imports: 7 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func MakeWriter(w io.Writer) io.WriteCloser

MakeWriter creates a io.WriteCloser out of any io.Writer

func MakeWriterCloser(w io.Writer, fn func() error) io.WriteCloser

MakeWriterCloser creates a io.WriterCloser

type Markdown struct {
	// contains filtered or unexported fields
}

Markdown renders a markdown document with a writer and some Options for rendering

func NewMarkdown(w io.WriteCloser, options Options) *Markdown

NewMarkdown creates a Markdown with the correct dependencies

func (o Markdown) Output(docs []entry.Document) error

Output takes a slice of documents and generates a markdown document from them

type Options struct {
	Header    string
	Optionals bool
}

Options define certain setup values for rendering markdown

func NewApiaryOptions(name string) Options

NewApiaryOptions make new Options for the Apiary format

type Plaintext struct {
	// contains filtered or unexported fields
}

func NewPlaintext(w io.WriteCloser) *Plaintext

func (o Plaintext) Output(docs []entry.Document) error