htmlout

Documentation

Index

• Constants
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func ToString(paragraphs []token.ParagraphToken, options sMark.Options) []byte
• type CodeNode
  • func (n CodeNode) HTML(_ int) string
• type HTMLNode
  • func (n *HTMLNode) AddChildren(children *HTMLNode)
  • func (n *HTMLNode) AddChildrenNode(children Node)
  • func (n *HTMLNode) HTML(indentation int) string
• type Node
• type TextNode
  • func (n TextNode) HTML(indentation int) string

Constants

const (
	//DefaultStyle is the default theme used when highlight code
	DefaultStyle = "vs"

	//StyleOption is the string options used to define the style
	StyleOption = "Style"

	//PrintLineOption is the bool options used to determine wheteever to print the line number
	//near code lines, default true
	PrintLineOption = "ShowCodeLines"

	//OnlyBodyOption is the Bool Option that specify to output only the body of the HTML Document
	OnlyBodyOption = "OnlyBody"

	//CustomTemplateOption is the String Option used to specify a custom template
	CustomTemplateOption = "TemplateFile"
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

func ToString

func ToString(paragraphs []token.ParagraphToken, options sMark.Options) []byte

ToString is a simple output enging with a simple HTML writer

Types

type CodeNode

type CodeNode TextNode

CodeNode is a TextNode with doen't adds indentation

func (CodeNode) HTML

func (n CodeNode) HTML(_ int) string

HTML return the content of the CodeNode but without indentation

type HTMLNode

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

HTMLNode is a node rapresenting an HTML element

func (*HTMLNode) AddChildren

func (n *HTMLNode) AddChildren(children *HTMLNode)

AddChildren adds a children to an HtmlNode

func (*HTMLNode) AddChildrenNode

func (n *HTMLNode) AddChildrenNode(children Node)

AddChildrenNode adds a generic children to the node

func (*HTMLNode) HTML

func (n *HTMLNode) HTML(indentation int) string

HTML generate HTML from the node

type Node

type Node interface {
	//HTML produces an HTML element from the Node
	//the argument is the indentation
	HTML(indentation int) string
}

Node is a generic node

type TextNode

type TextNode string

TextNode is a node containing string

func (TextNode) HTML

func (n TextNode) HTML(indentation int) string

HTML return the content of the node Correctly indented