Documentation
¶
Index ¶
- func LoadDir(ctx context.Context, hs *help.HelpSystem, dir string) error
- func LoadFile(ctx context.Context, hs *help.HelpSystem, filePath string) error
- func LoadPaths(ctx context.Context, hs *help.HelpSystem, paths []string) error
- func ReplaceStoreWithPaths(ctx context.Context, hs *help.HelpSystem, paths []string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LoadDir ¶
LoadDir walks a local directory recursively and loads all non-README markdown files into the help store.
func LoadPaths ¶
LoadPaths loads one or more markdown files or directories into the help store. Directories are walked recursively.
func ReplaceStoreWithPaths ¶
ReplaceStoreWithPaths clears any preloaded sections and reloads the help store from the provided files or directories.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.