Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNotFoundPage = errors.New("no page found")
Functions ¶
This section is empty.
Types ¶
type CmdExample ¶
CmdExample a command example in a tldr page
type CmdInfo ¶
type CmdInfo struct { Name string `json:"name"` Platforms []Platform `json:"platform"` Languages []string `json:"language"` }
CmdInfo contains name, platform, language
type Cmds ¶
type Cmds []*CmdInfo
Cmds a slice of CmdInfo
type CmdsIndex ¶
type CmdsIndex struct {
Commands Cmds `json:"commands"`
}
CmdsIndex structure of index.json
type Page ¶
type Page struct { CmdName string CmdDescriptions []string CmdExamples []*CmdExample }
Page contents of a tldr page
type Tldr ¶
type Tldr struct {
// contains filtered or unexported fields
}
Tldr Repository of tldir pages
func (*Tldr) LoadIndexFile ¶
LoadIndexFile load command index file
func (*Tldr) OnInitialize ¶
OnInitialize create and update tldr directory
Click to show internal directories.
Click to hide internal directories.