bcontent

type Page struct {

	// Source is the filesystem that the page is stored in.
	Source fs.FS `toml:"-" json:"-"`

	// Filename is the name of the file in [Page.FS] that the content is stored in.
	Filename string `toml:"-" json:"-"`

	// Name is the user-friendly name of the page, defaulting to the
	// [strcase.ToSentence] of the [Page.Filename] without its extension.
	Name string

	// URL is the URL of the page relative to the root of the app, without
	// any leading slash. It defaults to [Page.Name] in kebab-case
	// (ex: "home" or "text-fields"). A blank URL ("") manually
	// specified in the front matter indicates that this the root page.
	URL string

	// Title is the title displayed at the top of the page. It defaults to [Page.Name].
	// Note that [Page.Name] is still used for the stage title and other such things; this
	// is only for the actual title widget.
	Title string

	// Date is the optional date that the page was published.
	Date time.Time `toml:"-"`

	// DateString is only used for parsing the date from the TOML front matter.
	DateString string `toml:"Date" json:"-"`

	// Authors are the optional authors of the page.
	Authors []string

	// Draft indicates that the page is a draft and should not be visible on the web.
	Draft bool

	// Categories are the categories that the page belongs to.
	Categories []string

	// Specials are special content elements for each page
	// that have names with an underscore-delimited key name,
	// such as figure_, table_, sim_ etc, and can be referred
	// to using the #id component of a wikilink. They are rendered
	// using the index of each such element (e.g., Figure 1) in the link.
	Specials map[string][]string
}

type PreRenderPage struct {
	Page

	// Description is the automatic page description.
	Description string

	// HTML is the pre-rendered HTML for the page.
	HTML string
}