html5

package

v0.4.0 Latest Latest Go to latest Published: Apr 19, 2020 License: Apache-2.0 Imports: 19 Imported by: 0

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 EscapeString(s string) string

EscapeString uses the stdlib html5.Escape func except but bypasses a few replacements which

func NewTableOfContents(ctx renderer.Context, doc types.Document) (types.TableOfContents, error)

NewTableOfContents initializes a TableOfContents from the sections of the given document

func Render(ctx renderer.Context, doc types.Document, output io.Writer) (types.Metadata, error)

Render renders the given document in HTML and writes the result in the given `writer`

type Attribution struct {
	First  string
	Second string
}

Attribution a document block attribution

func NewDelimitedBlockAttribution(b types.DelimitedBlock) Attribution

NewDelimitedBlockAttribution return a new attribution for the given delimited block. Can be empty if no attribution was specified.

func NewParagraphAttribution(p types.Paragraph) Attribution

NewParagraphAttribution return a new attribution for the given paragraph. Can be empty if no attribution was specified.

type ContextualPipeline struct {
	Context renderer.Context
	// The actual pipeline
	Data interface{}
}

ContextualPipeline as structure that carries the renderer context along with the pipeline data to process in a template or in a nested template

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

RenderLinesConfig the config to use when rendering paragraph lines

type RenderLinesOption func(c *RenderLinesConfig)

RenderLinesOption an option to configure the rendering

func PlainText() RenderLinesOption

PlainText sets the render func to PlainText instead of HTML

func WithHardBreaks(hardbreaks bool) RenderLinesOption

WithHardBreaks sets the hard break option

type TableOfContents struct {
	Content template.HTML
}

TableOfContents the structure of the table of contents

type TableOfContentsSection struct {
	Level    int
	Href     string
	Title    template.HTML
	Elements template.HTML
}

TableOfContentsSection a section in the table of contents

type TableOfContentsSectionGroup struct {
	Level    int
	Elements []TableOfContentsSection
}

TableOfContentsSectionGroup a group of sections in the table of contents