page

Documentation

Index

• type Generator
  • func NewGenerator(markdownPath string, HTMLPath string, fs afero.Fs, ...) *Generator
  • func (g *Generator) Generate() error
  • func (g *Generator) Validate() error

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

func NewGenerator

func NewGenerator(
	markdownPath string,
	HTMLPath string,
	fs afero.Fs,
	sectionResolver section.Resolver,
	hrefPathsResolver hrefpath.Resolver,
	assetPathsResolver relpath.Resolver,
	validations *validation.Registry,
) *Generator

func (*Generator) Generate

func (g *Generator) Generate() error

Generate generates an HTML page by projecting the markdown file into the HTML template.

func (*Generator) Validate

func (g *Generator) Validate() error

Validate triggers structural validation checks on the generated HTML content. Note: This must be called after a successful invocation of Generate().