help

Documentation

Overview

Package help manages the built-in documentation.

Index

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

Variables

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

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.