render

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExpandSection

func ExpandSection(doc *parser.Document, name string)

ExpandSection shows full content of a section

func FilteredTree

func FilteredTree(doc *parser.Document, filter string)

FilteredTree shows only sections matching the filter

func MultiTree

func MultiTree(docs []*parser.Document, dirName string)

MultiTree renders multiple documents as a combined tree

func RefsTree

func RefsTree(docs []*parser.Document, dirName string)

RefsTree renders document references (links to other .md files)

func SearchResults added in v0.2.0

func SearchResults(docs []*parser.Document, query string)

SearchResults searches all docs for sections matching the query and renders results

func Tree

func Tree(doc *parser.Document)

Tree renders the full document map

Types

type SearchResult added in v0.2.0

type SearchResult struct {
	Filename string
	Path     string // e.g. "endpoints > Ban Member"
	Section  *parser.Section
}

SearchResult holds a matched section with its file context

Jump to

Keyboard shortcuts

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