glossary

package

v0.7.2 Latest Latest Go to latest Published: Mar 30, 2026 License: MIT Imports: 9 Imported by: 0

Details

Package glossary parses glossary definitions and highlights terms in HTML.

GLOSSARY.md format:

# Glossary

## API
Application Programming Interface.

## Markdown
A lightweight markup language.

This section is empty.

This section is empty.

This section is empty.

type Glossary struct {
	Terms []Term
	// contains filtered or unexported fields
}

Glossary stores parsed glossary terms.

func ParseFile(path string) (*Glossary, error)

ParseFile parses a glossary from GLOSSARY.md.

func (g *Glossary) ProcessHTML(html string) string

ProcessHTML highlights glossary terms in HTML body text.

func (g *Glossary) RenderHTML() string

RenderHTML renders the glossary as an HTML page.

type Term struct {
	Name       string // Term name.
	Definition string // Term definition.
}

Term represents a single glossary entry.