help

package

v1.2.0 Latest Latest Go to latest Published: Jan 29, 2024 License: AGPL-3.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.sr.ht/~bouncepaw/betula

Links

Open Source Insights

Documentation ¶

Overview ¶

Package help manages the built-in documentation.

Index ¶

Variables
type Topic
- func GetEnglishHelp(topicName string) (topic Topic, found bool)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Topics = []Topic{
		{"index", "Betula introduction", ""},
		{"meta", "Metainformation", ""},
		{"mycomarkup", "Mycomarkup formatting", ""},
		{"search", "Advanced search", ""},
	}
)

Functions ¶

This section is empty.

Types ¶

type Topic ¶

type Topic struct {
	Name         string
	SidebarTitle string
	Rendered     template.HTML
}

func GetEnglishHelp ¶

func GetEnglishHelp(topicName string) (topic Topic, found bool)

GetEnglishHelp returns English-language help for the given topic.

Source Files ¶

View all Source files

help.go

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