contenthub

type ContentConvertProvider interface {
	GetContentConvertProvider(name string) ConverterProvider
}

type ContentHub interface {
	CollectPages() error
	PreparePages() error
	RenderPages(td TemplateDescriptor, cb func(info PageInfo) error) error

	RenderString(ctx context.Context, args ...any) (goTmpl.HTML, error)

	SetTemplateExecutor(exec TemplateExecutor)

	Title
}

type ContentProvider interface {
	Content() (any, error)
}

type Converter interface {
	Convert(ctx markdown.RenderContext) (Result, error)
}

type ConverterProvider interface {
	New(ctx markdown.DocumentContext) (Converter, error)
	Name() string
}

type ConverterRegistry interface {
	Get(name string) ConverterProvider
}

type File interface {
	FileWithoutOverlap
	// contains filtered or unexported methods
}

type FileProvider interface {
	File() File
}

type FileWithoutOverlap interface {

	// Filename gets the full path and filename to the file.
	Filename() string

	// Dir gets the name of the directory that contains this file.
	// The directory is relative to the content root.
	Dir() string

	// Extension is an alias to Ext().
	// Deprecated: Use Ext instead.
	Extension() string

	// Ext gets the file extension, i.e "myblogpost.md" will return "md".
	Ext() string

	// LogicalName is filename and extension of the file.
	LogicalName() string

	// BaseFileName is a filename without extension.
	BaseFileName() string

	// TranslationBaseName is a filename with no extension,
	// not even the optional language extension part.
	TranslationBaseName() string

	// ContentBaseName is a either TranslationBaseName or name of containing folder
	// if file is a leaf bundle.
	ContentBaseName() string

	// UniqueID is the MD5 hash of the file's path and is for most practical applications,
	// Hugo content files being one of them, considered to be unique.
	UniqueID() string

	FileInfo() fsVO.FileMetaInfo
}

type Fs interface {
	LayoutFs() afero.Fs
	ContentFs() afero.Fs
}

type Page interface {
	ContentProvider
	PageWithoutContent
}

type PageInfo interface {
	Kind() string
	Sections() []string
	Dir() string
	Name() string
	Buffer() *bytes.Buffer
}

type PageMetaProvider interface {

	// Kind The Page Kind. One of page, home, section, taxonomy, term.
	Kind() string

	// SectionsEntries Returns a slice of sections (directories if it's a file) to this
	// Page.
	SectionsEntries() []string

	// Layout The configured layout to use to render this page. Typically set in front matter.
	Layout() string

	// Type is a discriminator used to select layouts etc. It is typically set
	// in front matter, but will fall back to the root section.
	Type() string
}

type PageWithoutContent interface {
	// FileProvider For pages backed by a file.
	FileProvider

	PageMetaProvider
}

type ProviderProvider interface {
	New() (ConverterProvider, error)
}

type Result interface {
	Bytes() []byte
}

type TemplateDescriptor interface {
	Name() string
	Extension() string
}

type TemplateExecutor interface {
	ExecuteWithContext(ctx context.Context, tmpl template.Preparer, wr io.Writer, data any) error
	LookupLayout(d template.LayoutDescriptor) (template.Preparer, bool, error)
}

type Title interface {
	CreateTitle(raw string) string
}