helputil

Documentation

Overview

Package helputil .

A utility for putting help pages in md files and importing them via go embed

to use add a directory called `topic` and go embed it via
```
//go:embed topics/*
var helpTopics embed.FS

func init() {
	htopic.MustAddFS(helpTopics)
}
```

this does not include an implementation of how to get or identify the right file
implementations of a help command will need to figure that out themselves

Index

• func Add(page, text string) bool
• func AddFS(f fs.FS) error
• func Get(page string) (string, bool)
• func List(prefix, suffix, contains string) []string
• func MustAdd(page, text string)
• func MustAddFS(f fs.FS)

Functions

func Add

func Add(page, text string) bool

Add a help topic, will not overwrite an existing help topic

func AddFS

func AddFS(f fs.FS) error

AddFS adds a list of help topics from a fs.FS

func Get

func Get(page string) (string, bool)

Get a help topic, returns true if a page exists

func List

func List(prefix, suffix, contains string) []string

List gets a list of topics

func MustAdd

func MustAdd(page, text string)

MustAdd is Add but it panics if it fails

func MustAddFS

func MustAddFS(f fs.FS)

MustAddFS is AddFS but it panics if an error occours