site

Documentation

Index

• type ConfigService
• type ContentService
• type ContentSpec
• type Descriptor
• type FsService
• type Language
• type LanguageService
• type Menu
• type Publisher
• type ResourceService
• type Services
• type Site
• type Template
• type TranslationService
• type URL
• type URLService

Types

type ConfigService

type ConfigService interface {
	ConfigParams() map[string]any
	SiteTitle() string
	Menus() map[string][]Menu
}

type ContentService

type ContentService interface {
	WalkPages(langIndex int, walker contenthub.WalkFunc) error
	GetPageSources(page contenthub.Page) ([]contenthub.PageSource, error)
	WalkTaxonomies(langIndex int, walker contenthub.WalkTaxonomyFunc) error
	GlobalPages() contenthub.Pages
	GlobalRegularPages() contenthub.Pages

	GetPageFromPath(path string) (contenthub.Page, error)
	GetPageRef(context contenthub.Page, ref string, home contenthub.Page) (contenthub.Page, error)
}

type ContentSpec

type ContentSpec interface {
	PreparePages() error
	RenderPages(func(kind string, sec []string, dir, name string, buf *bytes.Buffer) error) error
}

type Descriptor

type Descriptor struct {
	// The content to publish.
	Src io.Reader

	// The OutputFormat of this content.
	OutputFormat output.Format

	// Where to publish this content. This is a filesystem-relative path.
	TargetPath string

	// If set, will replace all relative URLs with this one.
	AbsURLPath string
}

Descriptor describes the needed publishing chain for an item.

type FsService

type FsService interface {
	Publish() afero.Fs
	WorkingDir() string
}

type Language

type Language interface {
	Location() *time.Location
	Collator() *collate.Collator
}

type LanguageService

type LanguageService interface {
	DefaultLanguage() string
	LanguageKeys() []string
	GetLanguageIndex(lang string) (int, error)
	GetLanguageName(lang string) string
}

type Menu

type Menu interface {
	Name() string
	URL() string
	Weight() int
}

type Publisher

type Publisher interface {
	Publish(d Descriptor) error
}

Publisher publishes a result file.

type ResourceService

type ResourceService interface {
	GetResourceWithOpener(pathname string, opener pio.OpenReadSeekCloser) (resources.Resource, error)
}

type Services

type Services interface {
	ContentService
	TranslationService
	ResourceService
	LanguageService
	FsService
	URLService
	ConfigService
}

type Site

type Site interface {
	URL
	Language
}

type Template

type Template interface {
	MarkReady() error
	LookupLayout(names []string) (template.Preparer, bool, error)
	ExecuteWithContext(ctx context.Context, t template.Preparer, wr io.Writer, data any) error
}

type TranslationService

type TranslationService interface {
	Translate(ctx context.Context, lang string, translationID string, templateData any) string
}

type URL

type URL interface {
	AbsURL(in string) string
	RelURL(in string) string
	URLize(uri string) string
}

type URLService

type URLService interface {
	BaseUrl() string
}