parser

Documentation

Index

• Variables
• func ExtractFrontmatter(source []byte) (map[string]interface{}, error)
• func FrontmatterToJSON(fm map[string]interface{}) string
• func GetTags(fm map[string]interface{}) []string
• func GetTitle(fm map[string]interface{}) string
• func GetWikilinks(fm map[string]interface{}) []string
• func MetaGet(pc parser.Context) map[string]interface{}
• type ParseResult
  • func ParseFile(absPath string, relPath string, source []byte, contentHash string) (*ParseResult, error)
• type RawLink

Variables

var MetaExt goldmark.Extender = &metaExtension{}

MetaExt is a goldmark.Extender that parses YAML frontmatter.

Functions

func ExtractFrontmatter

func ExtractFrontmatter(source []byte) (map[string]interface{}, error)

ExtractFrontmatter extracts YAML frontmatter from markdown bytes using goldmark-meta. Returns nil, nil if no frontmatter is present.

func FrontmatterToJSON

func FrontmatterToJSON(fm map[string]interface{}) string

FrontmatterToJSON converts a frontmatter map to a JSON string. Returns "" if fm is nil.

func GetTags

func GetTags(fm map[string]interface{}) []string

GetTags extracts the "tags" field from frontmatter, handling both []interface{} and []string.

func GetTitle

func GetTitle(fm map[string]interface{}) string

GetTitle extracts the "title" field from frontmatter.

func GetWikilinks

func GetWikilinks(fm map[string]interface{}) []string

GetWikilinks scans all string values in the frontmatter map for [[...]] patterns and returns the wikilink targets. Handles both string and slice values.

func MetaGet

func MetaGet(pc parser.Context) map[string]interface{}

MetaGet returns the YAML frontmatter map stored in a parser.Context.

Types

type ParseResult

type ParseResult struct {
	DocNode  store.Node
	Headings []store.Node
	Defs     []store.Node
	Tags     []store.Node // Deduplicated tag nodes
	Edges    []store.Edge
	RawLinks []RawLink
	FileInfo store.FileInfo
}

ParseResult contains all data extracted from a single markdown file.

func ParseFile

func ParseFile(absPath string, relPath string, source []byte, contentHash string) (*ParseResult, error)

ParseFile parses a markdown file and extracts nodes, edges, and raw links.

type RawLink

type RawLink struct {
	Text       string // Display text
	Target     string // Link target (path, wikilink name, URL)
	Kind       string // "wikilink", "markdown_link", "embed", "external"
	Line       int
	FromNodeID string // ID of the containing node
}

RawLink represents a link found during parsing, before resolution.