docs

Documentation

Index

• type Doc
  • func NewDoc() (doc *Doc)
  • func (doc *Doc) Sprint() (s string)
• type Docs
  • func LoadDocuments(path string) (documents Docs, err error)
  • func NewDocs() (docs Docs)
  • func (docs Docs) Find(key string) (doc *Doc, err error)
  • func (docs Docs) ReadFile(fileName string) (err error)
  • func (docs Docs) Sprint() (s string)
  • func (docs Docs) WriteFile(fileName string) (err error)

Types

type Doc

type Doc struct {
	Refer   string            `json:"refer"`
	Title   string            `json:"title"`
	Link    string            `json:"link"`
	Href    string            `json:"href"`
	Text    []string          `json:"text"`
	Support map[string]string `json:"support"`
	Subs    []*Doc            `json:"subs"`
}

func NewDoc

func NewDoc() (doc *Doc)

func (*Doc) Sprint

func (doc *Doc) Sprint() (s string)

type Docs

type Docs map[string]*Doc

func LoadDocuments

func LoadDocuments(path string) (documents Docs, err error)

func NewDocs

func NewDocs() (docs Docs)

func (Docs) Find

func (docs Docs) Find(key string) (doc *Doc, err error)

func (Docs) ReadFile

func (docs Docs) ReadFile(fileName string) (err error)

func (Docs) Sprint

func (docs Docs) Sprint() (s string)

func (Docs) WriteFile

func (docs Docs) WriteFile(fileName string) (err error)