Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContentFile ¶
type ContentFile struct {
// The built (i.e. HTML) content.
Content string `yaml:"Content"`
// The contents of the yaml header.
Metadata ContentMetadata `yaml:"Metadata"`
// The path to the built content file relative to the output directory.
Path string `yaml:"Path"`
// The markdown content of the file from below the yaml header.
RawContent string `yaml:"RawContent"`
// The path to the file the Content struct was built from.
SourcePath string `yaml:"SourcePath"`
}
Represents a markdown file with a YAML header containing metadata about that file.
func ReadFile ¶
func ReadFile(filePath string) (*ContentFile, error)
func (ContentFile) Validate ¶
func (contentFile ContentFile) Validate() error
Click to show internal directories.
Click to hide internal directories.