generators

Documentation

Index

• func EmbedListFiles(efs *embed.FS) ([]string, error)
• func MarkdownParseDate(f string) (time.Time, error)
• type Embed
  • func (*Embed) GetByProducts(ch chan *runner.GeneratorByProduct)
  • func (*Embed) GetID() string
  • func (*Embed) GetImmutable() bool
  • func (s *Embed) GetReader() (io.ReadCloser, error)
  • func (s *Embed) GetTimeStamps() ([]time.Time, error)
• type File
  • func (File) GetByProducts(ch chan *runner.GeneratorByProduct)
  • func (s File) GetID() string
  • func (File) GetImmutable() bool
  • func (s File) GetReader() (io.ReadCloser, error)
  • func (s File) GetTimeStamps() ([]time.Time, error)
• type HTTP
  • func (*HTTP) GetByProducts(ch chan *runner.GeneratorByProduct)
  • func (*HTTP) GetID() string
  • func (h *HTTP) GetImmutable() bool
  • func (h *HTTP) GetReader() (io.ReadCloser, error)
  • func (h *HTTP) GetTimeStamps() ([]time.Time, error)
• type Markdown
  • func (*Markdown) GetByProducts(ch chan *runner.GeneratorByProduct)
  • func (*Markdown) GetID() string
  • func (*Markdown) GetImmutable() bool
  • func (h *Markdown) GetReader() (io.ReadCloser, error)
  • func (h *Markdown) GetTimeStamps() ([]time.Time, error)
• type MarkdownSource
• type Project
  • func (p *Project) GetByProducts(ch chan *runner.GeneratorByProduct)
  • func (*Project) GetID() string
  • func (p *Project) GetImmutable() bool
  • func (p *Project) GetReader() (io.ReadCloser, error)
  • func (p *Project) GetTimeStamps() ([]time.Time, error)

Functions

func EmbedListFiles

func EmbedListFiles(efs *embed.FS) ([]string, error)

func MarkdownParseDate

func MarkdownParseDate(f string) (time.Time, error)

Types

type Embed

type Embed struct {
	FS   *embed.FS
	Name string
}

func (*Embed) GetByProducts

func (*Embed) GetByProducts(ch chan *runner.GeneratorByProduct)

func (*Embed) GetID

func (*Embed) GetID() string

func (*Embed) GetImmutable

func (*Embed) GetImmutable() bool

func (*Embed) GetReader

func (s *Embed) GetReader() (io.ReadCloser, error)

func (*Embed) GetTimeStamps

func (s *Embed) GetTimeStamps() ([]time.Time, error)

type File

type File string

func (File) GetByProducts

func (File) GetByProducts(ch chan *runner.GeneratorByProduct)

func (File) GetID

func (s File) GetID() string

func (File) GetImmutable

func (File) GetImmutable() bool

func (File) GetReader

func (s File) GetReader() (io.ReadCloser, error)

func (File) GetTimeStamps

func (s File) GetTimeStamps() ([]time.Time, error)

type HTTP

type HTTP struct {
	Url       string
	Header    http.Header
	Immutable bool
	// contains filtered or unexported fields
}

func (*HTTP) GetByProducts

func (*HTTP) GetByProducts(ch chan *runner.GeneratorByProduct)

func (*HTTP) GetID

func (*HTTP) GetID() string

func (*HTTP) GetImmutable

func (h *HTTP) GetImmutable() bool

func (*HTTP) GetReader

func (h *HTTP) GetReader() (io.ReadCloser, error)

func (*HTTP) GetTimeStamps

func (h *HTTP) GetTimeStamps() ([]time.Time, error)

type Markdown

type Markdown struct {
	Title             string
	Description       string
	URL               string
	SeriesStatus      string
	Sources           []*MarkdownSource
	IsPost            bool
	ExtraDependencies []string
	HighlightStyle    string
	Template          string
	TemplateCtx       map[string]interface{}
	Pagination        *templates.ContentPagination
	LayoutCtx         *templates.LayoutContext
}

func (*Markdown) GetByProducts

func (*Markdown) GetByProducts(ch chan *runner.GeneratorByProduct)

func (*Markdown) GetID

func (*Markdown) GetID() string

func (*Markdown) GetImmutable

func (*Markdown) GetImmutable() bool

func (*Markdown) GetReader

func (h *Markdown) GetReader() (io.ReadCloser, error)

func (*Markdown) GetTimeStamps

func (h *Markdown) GetTimeStamps() ([]time.Time, error)

type MarkdownSource

type MarkdownSource struct {
	File string
	URL  string
}

type Project

type Project struct {
	Owner     string
	Repo      string
	URL       string
	Template  string
	LayoutCtx *templates.LayoutContext
	Immutable bool
	// contains filtered or unexported fields
}

func (*Project) GetByProducts

func (p *Project) GetByProducts(ch chan *runner.GeneratorByProduct)

func (*Project) GetID

func (*Project) GetID() string

func (*Project) GetImmutable

func (p *Project) GetImmutable() bool

func (*Project) GetReader

func (p *Project) GetReader() (io.ReadCloser, error)

func (*Project) GetTimeStamps

func (p *Project) GetTimeStamps() ([]time.Time, error)