generator

Documentation

Index

• Constants
• func CollectEntries(dir string) []string
• func GenerateCommandsTemplate() (*template.Template, error)
• func GenerateEntriesTemplate(txt []byte) (*template.Template, error)
• func GenerateFileName(dir, s string) string
• func GenerateFileNameFromGlob(dir, s string) string
• func GenerateTitleFromFileName(file string) string
• func GenerateURLFromFileName(s string) string
• func RenderEntry(this_entry *Entry) error
• type Entry
  • func GenerateEntries(dir, render_dir, description string) ([]*Entry, error)
  • func GenerateEntry(file, dir, render_dir, description string) (*Entry, error)

Constants

const FrontMatter = `---

layout: single
type: docs
title: "Documentation | {{ .Description }} | {{ $name }}"

---`

Functions

func CollectEntries

func CollectEntries(dir string) []string

func GenerateCommandsTemplate

func GenerateCommandsTemplate() (*template.Template, error)

func GenerateEntriesTemplate

func GenerateEntriesTemplate(txt []byte) (*template.Template, error)

func GenerateFileName

func GenerateFileName(dir, s string) string

func GenerateFileNameFromGlob

func GenerateFileNameFromGlob(dir, s string) string

func GenerateTitleFromFileName

func GenerateTitleFromFileName(file string) string

func GenerateURLFromFileName

func GenerateURLFromFileName(s string) string

func RenderEntry

func RenderEntry(this_entry *Entry) error

Types

type Entry

type Entry struct {
	Title          string
	Template       *template.Template
	Specifications []*Entry
	Examples       []*Entry
	Description    string
	FileName       string
	CmdEntryPoint  string
	URL            string
	BaseURL        string
}

func GenerateEntries

func GenerateEntries(dir, render_dir, description string) ([]*Entry, error)

func GenerateEntry

func GenerateEntry(file, dir, render_dir, description string) (*Entry, error)