models

Documentation

Overview

Package models is for loading and updating documentation files.

Index

• func GetDoc(app, fullName, lang string) *docFile
• func InitModels()
• type CustomRender
  • func (cr *CustomRender) BlockCode(out *bytes.Buffer, text []byte, lang string)
• type DocList
  • func (s DocList) Len() int
  • func (s DocList) Less(i, j int) bool
  • func (s DocList) Swap(i, j int)
• type DocNode
  • func (d *DocNode) GetContent() string
  • func (d *DocNode) HasContent() bool
  • func (d *DocNode) SortDocs()
• type DocRoot
  • func GetDocByLocale(name, lang string) *DocRoot
  • func ParseDocs(path string) (*DocRoot, error)
  • func (d *DocRoot) GetNodeByLink(link string) (*DocNode, bool)

Functions

func GetDoc

func GetDoc(app, fullName, lang string) *docFile

GetDoc returns 'docFile' by given name and language version.

func InitModels

func InitModels()

Types

type CustomRender

type CustomRender struct {
	blackfriday.Renderer
}

func (*CustomRender) BlockCode

func (cr *CustomRender) BlockCode(out *bytes.Buffer, text []byte, lang string)

type DocList

type DocList []*DocNode

func (DocList) Len

func (s DocList) Len() int

func (DocList) Less

func (s DocList) Less(i, j int) bool

func (DocList) Swap

func (s DocList) Swap(i, j int)

type DocNode

type DocNode struct {
	IsDir       bool
	Path        string
	RelPath     string
	FileRelPath string
	FilePath    string
	Date        time.Time
	Name        string
	Sort        int
	Link        string
	Docs        DocList

	Root   *DocRoot
	Parent *DocNode
	// contains filtered or unexported fields
}

func (*DocNode) GetContent

func (d *DocNode) GetContent() string

func (*DocNode) HasContent

func (d *DocNode) HasContent() bool

func (*DocNode) SortDocs

func (d *DocNode) SortDocs()

type DocRoot

type DocRoot struct {
	Wd   string
	Path string
	Doc  *DocNode
	// contains filtered or unexported fields
}

func GetDocByLocale

func GetDocByLocale(name, lang string) *DocRoot

func ParseDocs

func ParseDocs(path string) (*DocRoot, error)

func (*DocRoot) GetNodeByLink

func (d *DocRoot) GetNodeByLink(link string) (*DocNode, bool)