Documentation
¶
Index ¶
- Constants
- func FormatSanitize(kind string) string
- func FormatToLeadRune(kind string) rune
- func HandleJSONData(datum []byte) (interface{}, error)
- func HandleJSONMetaData(datum []byte) (map[string]interface{}, error)
- func HandleOrgMetaData(datum []byte) (map[string]interface{}, error)
- func HandleTOMLMetaData(datum []byte) (map[string]interface{}, error)
- func HandleYAMLData(datum []byte) (interface{}, error)
- func HandleYAMLMetaData(datum []byte) (map[string]interface{}, error)
- func InterfaceToConfig(in interface{}, mark rune, w io.Writer) error
- func InterfaceToFrontMatter(in interface{}, mark rune, w io.Writer) error
- type FrontmatterType
- type Page
Constants ¶
const ( // HTMLLead identifies the start of HTML documents. HTMLLead = "<" // YAMLLead identifies the start of YAML frontmatter. YAMLLead = "-" // YAMLDelimUnix identifies the end of YAML front matter on Unix. YAMLDelimUnix = "---\n" // YAMLDelimDOS identifies the end of YAML front matter on Windows. YAMLDelimDOS = "---\r\n" // YAMLDelim identifies the YAML front matter delimiter. YAMLDelim = "---" // TOMLLead identifies the start of TOML front matter. TOMLLead = "+" // TOMLDelimUnix identifies the end of TOML front matter on Unix. TOMLDelimUnix = "+++\n" // TOMLDelimDOS identifies the end of TOML front matter on Windows. TOMLDelimDOS = "+++\r\n" // TOMLDelim identifies the TOML front matter delimiter. TOMLDelim = "+++" // JSONLead identifies the start of JSON frontmatter. JSONLead = "{" // HTMLCommentStart identifies the start of HTML comment. HTMLCommentStart = "<!--" // HTMLCommentEnd identifies the end of HTML comment. HTMLCommentEnd = "-->" // BOM Unicode byte order marker BOM = '\ufeff' )
Variables ¶
This section is empty.
Functions ¶
func FormatSanitize ¶
FormatSanitize returns the canonical format name for a given kind.
TODO(bep) move to helpers
func FormatToLeadRune ¶
FormatToLeadRune takes a given format kind and return the leading front matter delimiter.
func HandleJSONData ¶ added in v0.36.1
HandleJSONData unmarshals JSON-encoded datum and returns a Go interface representing the encoded data structure.
func HandleJSONMetaData ¶
HandleJSONMetaData unmarshals JSON-encoded datum and returns a Go interface representing the encoded data structure.
func HandleOrgMetaData ¶ added in v0.20.1
HandleOrgMetaData unmarshals org-mode encoded datum and returns a Go interface representing the encoded data structure.
func HandleTOMLMetaData ¶
HandleTOMLMetaData unmarshals TOML-encoded datum and returns a Go interface representing the encoded data structure.
func HandleYAMLData ¶ added in v0.37.1
HandleYAMLData unmarshals YAML-encoded datum and returns a Go interface representing the encoded data structure.
func HandleYAMLMetaData ¶
HandleYAMLMetaData unmarshals YAML-encoded datum and returns a Go interface representing the encoded data structure.
func InterfaceToConfig ¶
InterfaceToConfig encodes a given input based upon the mark and writes to w.
Types ¶
type FrontmatterType ¶ added in v0.20.1
type FrontmatterType struct {
// Parse decodes content into a Go interface.
Parse func([]byte) (map[string]interface{}, error)
// contains filtered or unexported fields
}
FrontmatterType represents a type of frontmatter.
func DetectFrontMatter ¶
func DetectFrontMatter(mark rune) (f *FrontmatterType)
DetectFrontMatter detects the type of frontmatter analysing its first character.
type Page ¶
type Page interface {
// FrontMatter contains the raw frontmatter with relevant delimiters.
FrontMatter() []byte
// Content contains the raw page content.
Content() []byte
// IsRenderable denotes that the page should be rendered.
IsRenderable() bool
// Metadata returns the unmarshalled frontmatter data.
Metadata() (map[string]interface{}, error)
}
Page represents a parsed content page.
Source Files