docs

package

v0.0.8 Latest Latest Go to latest Published: Oct 30, 2026 License: AGPL-3.0 Imports: 8 Imported by: 0

Details

Package docs serves the documentation bundled in the binary so it is available offline.

This section is empty.

This section is empty.

This section is empty.

type Doc struct {
	Name  string `json:"name"`
	Title string `json:"title"`
}

Doc describes a bundled document.

type Match struct {
	Name string `json:"name"`
	Line int    `json:"line"`
	Text string `json:"text"`
}

Match is one search hit.

type Store struct{ FS fs.FS }

Store reads docs from a filesystem of top-level *.md files.

func Bundled() Store

Bundled returns the store embedded in this binary.

func (s Store) List() ([]Doc, error)

List returns all documents sorted by name.

func (s Store) Search(query string, limit int) ([]Match, error)

Search returns case-insensitive line matches across all documents. Every whitespace-separated term must appear in the line.

func (s Store) Show(name string) ([]byte, error)

Show returns a document by name, with or without the .md suffix.