parser

Documentation

Overview

Package parser provides Markdown parsing, slugification, and text chunking for notebrain-cli.

Index

• func Slugify(name string) string
• func TitleFromPath(path string) string
• type ASTChunk
• type ASTResult
  • func ParseAST(body, noteSlug string, maxChunkRunes int) ASTResult

Functions

func Slugify

func Slugify(name string) string

Slugify converts a note name/filename to a URL-safe slug. It lowercases, trims .md, replaces spaces with hyphens, and removes non-alphanumeric characters except hyphens.

func TitleFromPath

func TitleFromPath(path string) string

TitleFromPath derives a fallback title from the relative file path.

Types

type ASTChunk

type ASTChunk struct {
	NoteSlug    string
	Index       int
	Text        string // clean prose text for embedding
	HeadingPath string // e.g. "Architecture > Data Flow > Ingest"
	Level       int    // depth of the deepest heading in this chunk (1-6)
	CodeBlocks  int    // number of fenced code blocks in this chunk
	HasTable    bool
	HasTask     bool
	WordCount   int
}

ASTChunk is one section of a note, bounded by heading structure.

type ASTResult

type ASTResult struct {
	Chunks      []ASTChunk
	Tags        []string
	Links       []string
	Frontmatter map[string]interface{}
}

ASTResult is the output from parsing the full document, containing the chunks and metadata.

func ParseAST

func ParseAST(body, noteSlug string, maxChunkRunes int) ASTResult

ParseAST parses body text into ASTChunks, extracting wikilinks, tags, and frontmatter.