core

Documentation

Index

• Variables
• type AtWhy
  • func New(gen Generator, projectPath string, projectPathPrefix string, ...) (AtWhy, error)
  • func (a *AtWhy) Generate(template mdTemplate.Markdown, writer io.Writer) error
  • func (a *AtWhy) ListenAndServe(host string) error
  • func (a *AtWhy) Load() ([]mdTemplate.Markdown, error)
• type Generator
• type Loader
• type Page
• type TagProcessor
• type TemplateLoader

Variables

var TemplateFS embed.FS

Types

type AtWhy

type AtWhy struct {
	Loader         Loader
	Finder         loader.TagFinder
	TagFactories   []tag.Factory
	Generator      Generator
	TemplateLoader TemplateLoader
	// contains filtered or unexported fields
}

AtWhy combines all parts of the application. @WHY LINK atwhy_struct_link @WHY CODE atwhy_struct_code

func New

func New(gen Generator, projectPath string, projectPathPrefix string, templateFolder string, extensions []string, commentConfig map[string]finder.CommentConfig) (AtWhy, error)

func (*AtWhy) Generate

func (a *AtWhy) Generate(template mdTemplate.Markdown, writer io.Writer) error

func (*AtWhy) ListenAndServe

func (a *AtWhy) ListenAndServe(host string) error

func (*AtWhy) Load

func (a *AtWhy) Load() ([]mdTemplate.Markdown, error)

type Generator

type Generator interface {
	Generate(markdownTemplate mdTemplate.Markdown, writer io.Writer) error

	// Ext returns the file extension which should be used for the generated files.
	Ext() string
}

type Loader

type Loader interface {
	Load(finder loader.TagFinder) (allTags []tag.Raw, err error)
}

type Page

type Page = mdTemplate.Markdown

Page currently just consists of a markdown template. So all information included can be used in the html template.

type TagProcessor

type TagProcessor interface {
	Process(tags []tag.Raw) ([]tag.Tag, error)
}

type TemplateLoader

type TemplateLoader interface {
	Load(tags []tag.Tag) ([]mdTemplate.Markdown, error)
}