github

Documentation

Overview

Package github provides functionalities to decorate a repository with modules.

Index

• type Hydrator
  • func NewHydrator(finder module.Finder, opts ...HydratorOption) *Hydrator
  • func (h *Hydrator) Hydrate(s *site.Site) error
• type HydratorOption
  • func WithOutput(w io.Writer) HydratorOption

Types

type Hydrator

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

Hydrator is a config.Hydrator.

func NewHydrator

func NewHydrator(finder module.Finder, opts ...HydratorOption) *Hydrator

NewHydrator initiates a new config.Hydrator.

func (*Hydrator) Hydrate

func (h *Hydrator) Hydrate(s *site.Site) error

Hydrate hydrates the configuration.

type HydratorOption

type HydratorOption interface {
	// contains filtered or unexported methods
}

HydratorOption is an option to configure Hydrator.

func WithOutput

func WithOutput(w io.Writer) HydratorOption

WithOutput sets the output writer.