parser

package

Go to main page

Versions in this module

v0

v0.5.0

Sep 7, 2026

Changes in this version

+ var ErrBadRef = errors.New("unknown git ref")

+ var ErrNotRepo = errors.New("not a git repository")

+ func ChangedLinesBatch(root, ref string, files []string) (map[string]map[int]bool, error)

+ func EnsureRef(dir, ref string) error

+ func GitRoot(dir string) string

+ func IsDocPath(rel string) bool

+ func RecentFiles(dir string, limit int) []string

type Document

+ Source string

+ func ParseFile(path string) (*Document, error)

+ func (d *Document) SourceSpan(start, end int) string

+ type PathChange struct

+ OldPath string

+ Path string

+ Status string

+ func ChangedPaths(dir, ref string) ([]PathChange, error)

+ func ChangedPathsAll(dir, ref string) ([]PathChange, error)

v0.4.0

Apr 11, 2026

v0.3.1

Sep 7, 2026

v0.3.0

Apr 11, 2026

Changes in this version

+ func ChangedLines(file, ref string) (map[int]bool, error)

+ func Walk(root Node, fn func(Node) bool)

+ type AutoLink struct

+ IsBare bool

+ IsMail bool

+ URL string

+ type BaseNode struct

+ End int

+ Kids []Node

+ NKind NodeKind

+ Start int

+ TokCount int

+ func (b *BaseNode) Children() []Node

+ func (b *BaseNode) Kind() NodeKind

+ func (b *BaseNode) LineEnd() int

+ func (b *BaseNode) LineStart() int

+ func (b *BaseNode) Tokens() int

+ type Blockquote struct

+ type Callout struct

+ Variant CalloutKind

+ type CalloutKind string

+ const CalloutCaution

+ const CalloutImportant

+ const CalloutNote

+ const CalloutTip

+ const CalloutWarning

+ type CodeBlock struct

+ Code string

+ Fenced bool

+ Info string

+ Language string

+ type CommitRef struct

+ SHA string

+ type ContentSummary struct

+ Callouts int

+ CodeBlocks int

+ CommitRefs int

+ DefLists int

+ Emojis int

+ Footnotes int

+ HTMLBlocks int

+ IssueRefs int

+ LinkRefDefs int

+ MathBlocks int

+ Mentions int

+ Tables int

+ Tasks int

+ TasksChecked int

+ WikiEmbeds int

+ WikiLinks int

+ type Definition struct

+ type DefinitionList struct

+ type DefinitionTerm struct

+ Term string

+ type Delete struct

type Document

+ Nodes []Node

+ func (d *Document) Summary() ContentSummary

+ type Emoji struct

+ Name string

+ type Emphasis struct

+ type Entity struct

+ Decoded string

+ Raw string

+ type FootnoteDef struct

+ ID string

+ type FootnoteRef struct

+ ID string

+ type Frontmatter struct

+ Format FrontmatterFormat

+ Raw string

+ type FrontmatterFormat string

+ const FrontmatterJSON

+ const FrontmatterTOML

+ const FrontmatterYAML

+ type HTMLBlock struct

+ Raw string

+ type Heading struct

+ ID string

+ IsSetext bool

+ Level int

+ RawTitle string

+ Title string

+ type Image struct

+ Alt string

+ RefID string

+ Title string

+ URL string

+ type InlineCode struct

+ Code string

+ type InlineHTML struct

+ Raw string

+ type InlineMath struct

+ TeX string

+ type IssueRef struct

+ Number int

+ Repo string

+ type LineBreak struct

+ Hard bool

+ type Link struct

+ RefID string

+ Text string

+ Title string

+ URL string

+ type LinkRefDef struct

+ Label string

+ Title string

+ URL string

+ type List struct

+ Marker rune

+ Ordered bool

+ Start int

+ Tight bool

+ type ListItem struct

+ type MathBlock struct

+ Fence string

+ TeX string

+ type Mention struct

+ User string

+ type Node interface

+ Children func() []Node

+ Kind func() NodeKind

+ LineEnd func() int

+ LineStart func() int

+ Tokens func() int

+ func FindByKind(root Node, kind NodeKind) []Node

+ type NodeKind string

+ const KindAutoLink

+ const KindBlockquote

+ const KindCallout

+ const KindCodeBlock

+ const KindCommitRef

+ const KindDefTerm

+ const KindDefinition

+ const KindDefinitionList

+ const KindDelete

+ const KindEmoji

+ const KindEmphasis

+ const KindEntity

+ const KindFootnoteDef

+ const KindFootnoteRef

+ const KindFrontmatter

+ const KindHTMLBlock

+ const KindHeading

+ const KindImage

+ const KindInlineCode

+ const KindInlineHTML

+ const KindInlineMath

+ const KindIssueRef

+ const KindLineBreak

+ const KindLink

+ const KindLinkRefDef

+ const KindList

+ const KindListItem

+ const KindMathBlock

+ const KindMention

+ const KindParagraph

+ const KindStrong

+ const KindTable

+ const KindTableCell

+ const KindTableRow

+ const KindTaskItem

+ const KindText

+ const KindThematicBreak

+ const KindWikiEmbed

+ const KindWikiLink

+ type NotableStats struct

+ CommitRefs int

+ Emojis int

+ IssueRefs int

+ Mentions int

+ Tasks int

+ TasksChecked int

+ WikiEmbeds int

+ WikiLinks int

+ type Paragraph struct

+ Raw string

+ Text string

type Section

+ Notables []Node

+ Stats NotableStats

+ type Strong struct

+ type Table struct

+ Aligns []TableAlign

+ Headers []string

+ type TableAlign string

+ const AlignCenter

+ const AlignLeft

+ const AlignNone

+ const AlignRight

+ type TableCell struct

+ Align TableAlign

+ type TableRow struct

+ IsHeader bool

+ type TaskItem struct

+ Checked bool

+ type Text struct

+ Value string

+ type ThematicBreak struct

+ type WikiEmbed struct

+ Height int

+ Target string

+ Width int

+ type WikiLink struct

+ Alias string

+ Anchor string

+ Block string

+ Target string

v0.2.2

Apr 2, 2026

v0.2.1

Feb 22, 2026

v0.2.0

Feb 22, 2026

Changes in this version

type Document

+ func ParseYAML(content string) (*Document, error)

v0.1.0

Jan 29, 2026

Changes in this version

type Document

+ func ParsePDF(filepath string) (*Document, error)

v0.0.2

Dec 23, 2025

v0.0.1

Dec 23, 2025

Changes in this version

+ type Document struct

+ Filename string

+ References []Reference

+ Sections []*Section

+ TotalTokens int

+ func Parse(content string) *Document

+ func (d *Document) GetAllSections() []*Section

+ func (d *Document) GetSection(name string) *Section

+ type Reference struct

+ Line int

+ Target string

+ Text string

+ type Section struct

+ Children []*Section

+ Content string

+ KeyTerms []string

+ Level int

+ LineEnd int

+ LineStart int

+ Parent *Section

+ Title string

+ Tokens int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL