metadata

Documentation

Index

• Constants
• func ExtractDocumentLeadingH1(markdown []byte) string
• type Meta
  • func ExtractMeta(data []byte, spaceFromCli string, titleFromH1 bool, parents []string, ...) (*Meta, []byte, error)

Constants

const (
	HeaderParent      = `Parent`
	HeaderSpace       = `Space`
	HeaderType        = `Type`
	HeaderTitle       = `Title`
	HeaderLayout      = `Layout`
	HeaderAttachment  = `Attachment`
	HeaderLabel       = `Label`
	HeaderInclude     = `Include`
	HeaderSidebar     = `Sidebar`
	ContentAppearance = `Content-Appearance`
)

const (
	FullWidthContentAppearance = "full-width"
	FixedContentAppearance     = "fixed"
)

Functions

func ExtractDocumentLeadingH1

func ExtractDocumentLeadingH1(markdown []byte) string

ExtractDocumentLeadingH1 will extract leading H1 heading

Types

type Meta

type Meta struct {
	Parents           []string
	Space             string
	Type              string
	Title             string
	Layout            string
	Sidebar           string
	Attachments       []string
	Labels            []string
	ContentAppearance string
}

func ExtractMeta

func ExtractMeta(data []byte, spaceFromCli string, titleFromH1 bool, parents []string, titleAppendGeneratedHash bool) (*Meta, []byte, error)