helpdoc

package

v0.49.3 Latest Latest Go to latest Published: Jul 31, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/unkn0wn-root/resterm

Links

Documentation ¶

Overview ¶

Package helpdoc provides the embedded documentation shown by the TUI.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DocsRef ¶

func DocsRef(version string) string

DocsRef maps a build version to the git ref documentation links should use. Release tags link to their tag. Dev, snapshot, and dirty builds track main.

Types ¶

type DocRef ¶

type DocRef struct {
	Path    string
	Heading string
}

func Manual ¶

func Manual() DocRef

func (DocRef) URL ¶

func (d DocRef) URL(ref string) string

type Topic ¶

type Topic struct {
	ID      string
	Title   string
	Summary string
	Body    string
	Doc     DocRef
	// contains filtered or unexported fields
}

func Directive ¶

func Directive(name directive.Name) (Topic, bool)

Directive resolves a canonical directive name to its topic.

func Lookup ¶

func Lookup(query string) (Topic, bool)

Lookup resolves a topic ID, title, alias, keyword, or an @directive.

func Search ¶

func Search(query string) []Topic

Search returns topics whose metadata or body contains every query token.

func Suggest ¶

func Suggest(query string) []Topic

Suggest matches metadata only, so completion results stay precise.

func Topics ¶

func Topics() []Topic

Topics returns every topic in display order.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL