document

Documentation

Index

• type Doc
  • func New(name string, meta map[DocumentKey]interface{}, tags ...string) *Doc
  • func (d *Doc) AddTag(key string)
  • func (d *Doc) AppendFileInfo(info fs.FileInfo, anchor string)
  • func (d *Doc) AppendHTML(heading string, level uint, body template.HTML, anchor string, class string)
  • func (d *Doc) Description() string
  • func (d *Doc) HTML() []DocumentSection
  • func (d *Doc) Meta() map[DocumentKey]interface{}
  • func (d *Doc) SetMeta(key DocumentKey, value interface{})
  • func (d *Doc) Shortform() template.HTML
  • func (d *Doc) String() string
  • func (d *Doc) Tags() []string
  • func (d *Doc) Title() string

Types

type Doc

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

func New

func New(name string, meta map[DocumentKey]interface{}, tags ...string) *Doc

func (*Doc) AddTag

func (d *Doc) AddTag(key string)

func (*Doc) AppendFileInfo

func (d *Doc) AppendFileInfo(info fs.FileInfo, anchor string)

func (*Doc) AppendHTML

func (d *Doc) AppendHTML(heading string, level uint, body template.HTML, anchor string, class string)

func (*Doc) Description

func (d *Doc) Description() string

func (*Doc) HTML

func (d *Doc) HTML() []DocumentSection

func (*Doc) Meta

func (d *Doc) Meta() map[DocumentKey]interface{}

func (*Doc) SetMeta

func (d *Doc) SetMeta(key DocumentKey, value interface{})

func (*Doc) Shortform

func (d *Doc) Shortform() template.HTML

func (*Doc) String

func (d *Doc) String() string

func (*Doc) Tags

func (d *Doc) Tags() []string

func (*Doc) Title

func (d *Doc) Title() string