pagemeta

type BuildConfig struct {
	// Whether to add it to any of the page collections.
	// Note that the page can always be found with .Site.GetPage.
	// Valid values: never, always, local.
	// Setting it to 'local' means they will be available via the local
	// page collections, e.g. $section.Pages.
	// Note: before 0.57.2 this was a bool, so we accept those too.
	List string

	// Whether to render it.
	// Valid values: never, always, link.
	// The value link means it will not be rendered, but it will get a RelPermalink/Permalink.
	// Note that before 0.76.0 this was a bool, so we accept those too.
	Render string

	// Whether to publish its resources. These will still be published on demand,
	// but enabling this can be useful if the originals (e.g. images) are
	// never used.
	PublishResources bool
	// contains filtered or unexported fields
}

type Dates struct {
	Date        time.Time
	Lastmod     time.Time
	PublishDate time.Time
	ExpiryDate  time.Time
}

type DatesStrings struct {
	Date        string `json:"date"`
	Lastmod     string `json:"lastMod"`
	PublishDate string `json:"publishDate"`
	ExpiryDate  string `json:"expiryDate"`
}

type FrontMatterDescriptor struct {
	// This is the Page's base filename (BaseFilename), e.g. page.md., or
	// if page is a leaf bundle, the bundle folder name (ContentBaseName).
	BaseFilename string

	// The Page's path if the page is backed by a file, else its title.
	PathOrTitle string

	// The content file's mod time.
	ModTime time.Time

	// May be set from the author date in Git.
	GitAuthorDate time.Time

	// The below will be modified.
	PageConfig *PageConfig

	// The Location to use to parse dates without time zone info.
	Location *time.Location
}

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

type FrontMatterOnlyValues struct {
	ResourcesMeta []map[string]any
}

type FrontmatterConfig struct {
	// Controls how the Date is set from front matter.
	Date []string
	// Controls how the Lastmod is set from front matter.
	Lastmod []string
	// Controls how the PublishDate is set from front matter.
	PublishDate []string
	// Controls how the ExpiryDate is set from front matter.
	ExpiryDate []string
}

type PageConfig struct {
	Dates Dates `json:"-"` // Dates holds the four core dates for this page.
	DatesStrings
	PageConfigEarly `mapstructure:",squash"`
	Title           string   // The title of the page.
	LinkTitle       string   // The link title of the page.
	Type            string   // The content type of the page.
	Layout          string   // The layout to use for to render this page.
	Weight          int      // The weight of the page, used in sorting if set to a non-zero value.
	URL             string   // The URL to the rendered page, e.g. /sect/mypage.html.
	Slug            string   // The slug for this page.
	Description     string   // The description for this page.
	Summary         string   // The summary for this page.
	Draft           bool     // Whether or not the content is a draft.
	Headless        bool     `json:"-"` // Whether or not the page should be rendered.
	IsCJKLanguage   bool     // Whether or not the content is in a CJK language.
	TranslationKey  string   // The translation key for this page.
	Keywords        []string // The keywords for this page.
	Aliases         []string // The aliases for this page.
	Outputs         []string // The output formats to render this page in. If not set, the site's configured output formats for this page kind will be used.

	FrontMatterOnlyValues `mapstructure:"-" json:"-"`

	Sitemap config.SitemapConfig
	Build   BuildConfig
	Menus   any // Can be a string, []string or map[string]any.

	// User defined params.
	Params maps.Params

	// The raw data from the content adapter.
	// TODO(bep) clean up the ContentAdapterData vs Params.
	ContentAdapterData map[string]any `mapstructure:"-" json:"-"`

	// Compiled values.
	CascadeCompiled         *maps.Ordered[page.PageMatcher, page.PageMatcherParamsConfig] `mapstructure:"-" json:"-"`
	ContentMediaType        media.Type                                                    `mapstructure:"-" json:"-"`
	ConfiguredOutputFormats output.Formats                                                `mapstructure:"-" json:"-"`
	IsFromContentAdapter    bool                                                          `mapstructure:"-" json:"-"`
}

type PageConfigEarly struct {
	Kind    string // The kind of page, e.g. "page", "section", "home" etc. This is usually derived from the content path.
	Path    string // The canonical path to the page, e.g. /sect/mypage. Note: Leading slash, no trailing slash, no extensions or language identifiers.
	Lang    string // The language code for this page. This is usually derived from the module mount or filename.
	Cascade []map[string]any

	// Content holds the content for this page.
	Content Source
}

type ResourceConfig struct {
	Path    string
	Name    string
	Title   string
	Params  maps.Params
	Content Source

	// Compiled values.
	PathInfo         *paths.Path `mapstructure:"-" json:"-"`
	ContentMediaType media.Type
}

type Source struct {
	// MediaType is the media type of the content.
	MediaType string

	// The markup used in Value. Only used in front matter.
	Markup string

	// The content.
	Value any
}