help

Documentation

Overview

Package help - Content managed by Project Forge, see [projectforge.md] for details.

Package help - Content managed by Project Forge, see [projectforge.md] for details.

Index

• type Entries
  • func (e Entries) Get(key string) *Entry
• type Entry
• type Service
  • func NewService(logger util.Logger) *Service
  • func (s *Service) Contains(key string) bool
  • func (s *Service) Entry(key string) *Entry

Types

type Entries

type Entries []*Entry

func (Entries) Get

func (e Entries) Get(key string) *Entry

type Entry

type Entry struct {
	Key      string `json:"key"`
	Title    string `json:"title,omitempty"`
	Markdown string `json:"markdown,omitempty"`
	HTML     string `json:"html,omitempty"`
}

type Service

type Service struct {
	Entries Entries
}

func NewService

func NewService(logger util.Logger) *Service

func (*Service) Contains

func (s *Service) Contains(key string) bool

func (*Service) Entry

func (s *Service) Entry(key string) *Entry