glossary

package

v0.4.2 Latest Latest Go to latest Published: Mar 20, 2026 License: MIT Imports: 7 Imported by: 0

Details

Package glossary parses glossary definitions and highlights terms in HTML.

GLOSSARY.md 格式：

# Glossary

## API
Application Programming Interface，应用程序编程接口。

## Markdown
一种轻量级标记语言。

This section is empty.

This section is empty.

This section is empty.

type Glossary struct {
	Terms []Term
}

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.