Documentation
¶
Index ¶
- type Docs
- func (d *Docs) CompleteTitle(docs []MarkdownDoc, match string) []string
- func (d *Docs) FilterByCategory(category string, docs []MarkdownDoc) (filteredDocs []MarkdownDoc)
- func (d *Docs) FilterByTag(tag string, docs []MarkdownDoc) (filteredDocs []MarkdownDoc)
- func (d *Docs) FindAndParse(docsFolderPath string)
- func (d *Docs) FormatFrontMatter(format string, docs []MarkdownDoc)
- func (d *Docs) InitHandler()
- func (d *Docs) InitRenderer() (err error)
- func (d *Docs) ListCategories(docs []MarkdownDoc) (categories []string)
- func (d *Docs) ListTags(docs []MarkdownDoc) (tags []string)
- func (d *Docs) ListTitles(docs []MarkdownDoc) (titles []Title)
- func (d *Docs) Render(body string) (output string, err error)
- func (d *Docs) RenderDocument(doc MarkdownDoc) (string, error)
- func (d *Docs) SelectDocument(shortTitle string, docs []MarkdownDoc) (document MarkdownDoc, err error)
- type DocsFrontMatter
- type DocsI
- type MarkdownDoc
- type Title
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Docs ¶
type Docs struct {
AFS *afero.Afero
IOFS *afero.IOFS
TermRenderer *glamour.TermRenderer
DocsFileSystem *embed.FS
MarkdownHandler *front.Matter
ParsedDocsCache []MarkdownDoc
}
func (*Docs) CompleteTitle ¶
func (d *Docs) CompleteTitle(docs []MarkdownDoc, match string) []string
func (*Docs) FilterByCategory ¶
func (d *Docs) FilterByCategory(category string, docs []MarkdownDoc) (filteredDocs []MarkdownDoc)
func (*Docs) FilterByTag ¶
func (d *Docs) FilterByTag(tag string, docs []MarkdownDoc) (filteredDocs []MarkdownDoc)
func (*Docs) FindAndParse ¶
func (*Docs) FormatFrontMatter ¶
func (d *Docs) FormatFrontMatter(format string, docs []MarkdownDoc)
func (*Docs) InitHandler ¶
func (d *Docs) InitHandler()
func (*Docs) InitRenderer ¶
func (*Docs) ListCategories ¶
func (d *Docs) ListCategories(docs []MarkdownDoc) (categories []string)
func (*Docs) ListTags ¶
func (d *Docs) ListTags(docs []MarkdownDoc) (tags []string)
func (*Docs) ListTitles ¶
func (d *Docs) ListTitles(docs []MarkdownDoc) (titles []Title)
func (*Docs) RenderDocument ¶
func (d *Docs) RenderDocument(doc MarkdownDoc) (string, error)
func (*Docs) SelectDocument ¶
func (d *Docs) SelectDocument(shortTitle string, docs []MarkdownDoc) (document MarkdownDoc, err error)
type DocsFrontMatter ¶
type MarkdownDoc ¶
type MarkdownDoc struct {
FrontMatter DocsFrontMatter
Body string
}
Source Files
Click to show internal directories.
Click to hide internal directories.