herald

package module

Go to main page

Versions in this module

v0

v0.13.0

Apr 3, 2026

Changes in this version

type Typography

+ func (t *Typography) BR() string

+ func (t *Typography) Section(blocks ...string) string

v0.12.0

Apr 1, 2026

Changes in this version

+ type KVOption func(*kvConfig)

+ func WithKVGroupSeparator(s string) KVOption

+ func WithKVIndent(n int) KVOption

+ func WithKVRawKeys(raw bool) KVOption

+ func WithKVRawValues(raw bool) KVOption

type Typography

+ func (t *Typography) KVGroupWithOpts(pairs [][2]string, opts ...KVOption) string

v0.11.0

Mar 31, 2026

Changes in this version

+ const DefaultQuoteClose

+ const DefaultQuoteOpen

type Option

+ func WithCiteStyle(s lipgloss.Style) Option

+ func WithFieldsetBorderStyle(s lipgloss.Style) Option

+ func WithFieldsetLegendStyle(s lipgloss.Style) Option

+ func WithFieldsetStyle(s lipgloss.Style) Option

+ func WithFieldsetWidth(w int) Option

+ func WithFigureCaptionStyle(s lipgloss.Style) Option

+ func WithQStyle(s lipgloss.Style) Option

+ func WithQuoteClose(s string) Option

+ func WithQuoteOpen(s string) Option

+ func WithSampStyle(s lipgloss.Style) Option

+ func WithVarStyle(s lipgloss.Style) Option

type Theme

+ Cite lipgloss.Style

+ Fieldset lipgloss.Style

+ FieldsetBorder lipgloss.Style

+ FieldsetLegend lipgloss.Style

+ FieldsetWidth int

+ FigureCaption lipgloss.Style

+ FigureCaptionPosition CaptionPosition

+ Q lipgloss.Style

+ QuoteClose string

+ QuoteOpen string

+ Samp lipgloss.Style

+ Var lipgloss.Style

type Typography

+ func (t *Typography) Cite(text string) string

+ func (t *Typography) Fieldset(legend, content string, width ...int) string

+ func (t *Typography) Figure(content, caption string) string

+ func (t *Typography) FigureTop(content, caption string) string

+ func (t *Typography) Q(text string) string

+ func (t *Typography) Samp(text string) string

+ func (t *Typography) Var(text string) string

v0.10.0

Mar 30, 2026

Changes in this version

+ const DefaultCodeLineNumberOffset

type Option

+ func WithCodeLineNumberOffset(n int) Option

type Theme

+ CodeLineNumberOffset int

v0.9.0

Mar 26, 2026

Changes in this version

type Typography

+ func (t *Typography) Compose(blocks ...string) string

v0.8.0

Mar 26, 2026

Changes in this version

type AlertPalette

+ func DefaultAlertPalette(sp SemanticPalette, p ColorPalette) AlertPalette

type Option

+ func WithErrorBadgeStyle(s lipgloss.Style) Option

+ func WithErrorTagStyle(s lipgloss.Style) Option

+ func WithInfoBadgeStyle(s lipgloss.Style) Option

+ func WithInfoTagStyle(s lipgloss.Style) Option

+ func WithSemanticPalette(sp SemanticPalette) Option

+ func WithSuccessBadgeStyle(s lipgloss.Style) Option

+ func WithSuccessTagStyle(s lipgloss.Style) Option

+ func WithWarningBadgeStyle(s lipgloss.Style) Option

+ func WithWarningTagStyle(s lipgloss.Style) Option

+ type SemanticPalette struct

+ Error color.Color

+ Info color.Color

+ Success color.Color

+ Warning color.Color

+ func DefaultSemanticPalette(p ColorPalette) SemanticPalette

type Theme

+ ErrorBadge lipgloss.Style

+ ErrorTag lipgloss.Style

+ InfoBadge lipgloss.Style

+ InfoTag lipgloss.Style

+ SuccessBadge lipgloss.Style

+ SuccessTag lipgloss.Style

+ WarningBadge lipgloss.Style

+ WarningTag lipgloss.Style

type Typography

+ func (t *Typography) ErrorBadge(text string) string

+ func (t *Typography) ErrorTag(text string) string

+ func (t *Typography) InfoBadge(text string) string

+ func (t *Typography) InfoTag(text string) string

+ func (t *Typography) SuccessBadge(text string) string

+ func (t *Typography) SuccessTag(text string) string

+ func (t *Typography) WarningBadge(text string) string

+ func (t *Typography) WarningTag(text string) string

v0.7.0

Mar 23, 2026

Changes in this version

+ const DefaultKVSeparator

+ const MaxWidthChars

type Option

+ func WithHRLabelStyle(s lipgloss.Style) Option

+ func WithKVKeyStyle(s lipgloss.Style) Option

+ func WithKVSeparator(s string) Option

+ func WithKVValueStyle(s lipgloss.Style) Option

type TableBorderSet

+ ColumnSep string

type Theme

+ HRLabel lipgloss.Style

+ KVKey lipgloss.Style

+ KVSeparator string

+ KVValue lipgloss.Style

type Typography

+ func (t *Typography) HRWithLabel(label string) string

+ func (t *Typography) KV(key, value string) string

+ func (t *Typography) KVGroup(pairs [][2]string) string

v0.6.0

Mar 21, 2026

Changes in this version

+ const DefaultDelPrefix

+ const DefaultFootnoteDividerChar

+ const DefaultFootnoteDividerWidth

+ const DefaultInsPrefix

type Option

+ func WithAddressCardBorderStyle(s lipgloss.Style) Option

+ func WithAddressCardStyle(s lipgloss.Style) Option

+ func WithAddressStyle(s lipgloss.Style) Option

+ func WithBadgeStyle(s lipgloss.Style) Option

+ func WithBlockquoteBarStyle(s lipgloss.Style) Option

+ func WithDelPrefix(c string) Option

+ func WithDelStyle(s lipgloss.Style) Option

+ func WithFootnoteDividerChar(c string) Option

+ func WithFootnoteDividerStyle(s lipgloss.Style) Option

+ func WithFootnoteDividerWidth(w int) Option

+ func WithFootnoteItemStyle(s lipgloss.Style) Option

+ func WithFootnoteRefStyle(s lipgloss.Style) Option

+ func WithInsPrefix(c string) Option

+ func WithInsStyle(s lipgloss.Style) Option

+ func WithTagStyle(s lipgloss.Style) Option

type Theme

+ Address lipgloss.Style

+ AddressCard lipgloss.Style

+ AddressCardBorder lipgloss.Style

+ Badge lipgloss.Style

+ BlockquoteBarStyle lipgloss.Style

+ Del lipgloss.Style

+ DelPrefix string

+ FootnoteDivider lipgloss.Style

+ FootnoteDividerChar string

+ FootnoteDividerWidth int

+ FootnoteItem lipgloss.Style

+ FootnoteRef lipgloss.Style

+ Ins lipgloss.Style

+ InsPrefix string

+ Tag lipgloss.Style

type Typography

+ func (t *Typography) Address(text string) string

+ func (t *Typography) AddressCard(text string) string

+ func (t *Typography) Badge(text string) string

+ func (t *Typography) BadgeWithStyle(text string, style lipgloss.Style) string

+ func (t *Typography) Del(text string) string

+ func (t *Typography) FootnoteRef(n int) string

+ func (t *Typography) FootnoteSection(notes []string) string

+ func (t *Typography) Ins(text string) string

+ func (t *Typography) Tag(text string) string

+ func (t *Typography) TagWithStyle(text string, style lipgloss.Style) string

v0.5.0

Mar 20, 2026

Changes in this version

+ const DefaultTableCellPad

+ type Alignment int

+ const AlignCenter

+ const AlignLeft

+ const AlignRight

+ type CaptionPosition int

+ const CaptionBottom

+ const CaptionTop

type Option

+ func WithTableBorderSet(bs TableBorderSet) Option

+ func WithTableBorderStyle(s lipgloss.Style) Option

+ func WithTableCaptionStyle(s lipgloss.Style) Option

+ func WithTableCellPad(n int) Option

+ func WithTableCellStyle(s lipgloss.Style) Option

+ func WithTableFooterStyle(s lipgloss.Style) Option

+ func WithTableHeaderStyle(s lipgloss.Style) Option

+ func WithTableStripedCellStyle(s lipgloss.Style) Option

+ type TableBorderSet struct

+ Bottom string

+ BottomJunction string

+ BottomLeft string

+ BottomRight string

+ Cross string

+ FooterCross string

+ FooterLeft string

+ FooterRight string

+ Header string

+ HeaderCross string

+ HeaderLeft string

+ HeaderRight string

+ Left string

+ LeftJunction string

+ Right string

+ RightJunction string

+ Row string

+ Top string

+ TopJunction string

+ TopLeft string

+ TopRight string

+ func BoxBorderSet() TableBorderSet

+ func MinimalBorderSet() TableBorderSet

+ type TableOption func(*tableConfig)

+ func WithCaption(text string) TableOption

+ func WithCaptionBottom(text string) TableOption

+ func WithColumnAlign(col int, align Alignment) TableOption

+ func WithColumnAligns(aligns ...Alignment) TableOption

+ func WithColumnMaxWidth(col, n int) TableOption

+ func WithFooterRow(enabled bool) TableOption

+ func WithMaxColumnWidth(n int) TableOption

+ func WithRowSeparators(enabled bool) TableOption

+ func WithStripedRows(enabled bool) TableOption

type Theme

+ TableBorder lipgloss.Style

+ TableBorderSet TableBorderSet

+ TableCaption lipgloss.Style

+ TableCell lipgloss.Style

+ TableCellPad int

+ TableFooter lipgloss.Style

+ TableHeader lipgloss.Style

+ TableStripedCell lipgloss.Style

type Typography

+ func (t *Typography) Table(rows [][]string) string

+ func (t *Typography) TableWithOpts(rows [][]string, opts ...TableOption) string

v0.4.0

Mar 19, 2026

Changes in this version

+ const DefaultCodeLineNumberSep

type Option

+ func WithCodeLineNumberSep(sep string) Option

+ func WithCodeLineNumberStyle(s lipgloss.Style) Option

+ func WithCodeLineNumbers(enabled bool) Option

type Theme

+ CodeLineNumber lipgloss.Style

+ CodeLineNumberSep string

+ ShowLineNumbers bool

v0.3.0

Mar 19, 2026

Changes in this version

+ const DefaultAlertBar

+ const DefaultAlertCautionIcon

+ const DefaultAlertCautionLabel

+ const DefaultAlertImportantIcon

+ const DefaultAlertImportantLabel

+ const DefaultAlertNoteIcon

+ const DefaultAlertNoteLabel

+ const DefaultAlertTipIcon

+ const DefaultAlertTipLabel

+ const DefaultAlertWarningIcon

+ const DefaultAlertWarningLabel

+ func DefaultAlertConfigs(ap AlertPalette) map[AlertType]AlertConfig

+ type AlertConfig struct

+ Icon string

+ Label string

+ Style lipgloss.Style

+ type AlertPalette struct

+ Caution color.Color

+ Important color.Color

+ Note color.Color

+ Tip color.Color

+ Warning color.Color

+ type AlertType int

+ const AlertCaution

+ const AlertImportant

+ const AlertNote

+ const AlertTip

+ const AlertWarning

type Option

+ func WithAlertBar(c string) Option

+ func WithAlertIcon(at AlertType, icon string) Option

+ func WithAlertLabel(at AlertType, label string) Option

+ func WithAlertPalette(ap AlertPalette) Option

+ func WithAlertStyle(at AlertType, s lipgloss.Style) Option

type Theme

+ AlertBar string

+ Alerts map[AlertType]AlertConfig

type Typography

+ func (t *Typography) Alert(at AlertType, text string) string

+ func (t *Typography) Caution(text string) string

+ func (t *Typography) Important(text string) string

+ func (t *Typography) Note(text string) string

+ func (t *Typography) Tip(text string) string

+ func (t *Typography) Warning(text string) string

v0.2.0

Mar 18, 2026

Changes in this version

+ const DefaultBlockquoteBar

+ const DefaultBulletChar

+ const DefaultH1UnderlineChar

+ const DefaultH2UnderlineChar

+ const DefaultH3UnderlineChar

+ const DefaultHRChar

+ const DefaultHRWidth

+ const DefaultHeadingBarChar

+ const DefaultListIndent

+ var DefaultNestedBulletChars = []string

+ type ColorPalette struct

+ Accent color.Color

+ Base color.Color

+ Highlight color.Color

+ Muted color.Color

+ Primary color.Color

+ Secondary color.Color

+ Surface color.Color

+ Tertiary color.Color

+ Text color.Color

+ type ListItem struct

+ Children []ListItem

+ Kind ListKind

+ Text string

+ func Item(text string) ListItem

+ func ItemWithChildren(text string, children ...ListItem) ListItem

+ func ItemWithOLChildren(text string, children ...ListItem) ListItem

+ func Items(texts ...string) []ListItem

+ type ListKind int

+ const Ordered

+ const Unordered

type Option

+ func WithCodeFormatter(fn func(code, language string) string) Option

+ func WithHierarchicalNumbers(enabled bool) Option

+ func WithListIndent(n int) Option

+ func WithNestedBulletChars(chars []string) Option

+ func WithPalette(p ColorPalette) Option

type Theme

+ CodeFormatter func(code, language string) string

+ HierarchicalNumbers bool

+ ListIndent int

+ NestedBulletChars []string

+ func Base16Theme() Theme

+ func CatppuccinTheme() Theme

+ func CharmTheme() Theme

+ func DraculaTheme() Theme

+ func ThemeFromPalette(p ColorPalette) Theme

type Typography

+ func (t *Typography) NestOL(items ...ListItem) string

+ func (t *Typography) NestUL(items ...ListItem) string

v0.1.0

Mar 17, 2026

Changes in this version

+ type Option func(*Typography)

+ func WithAbbrStyle(s lipgloss.Style) Option

+ func WithBlockquoteBar(c string) Option

+ func WithBlockquoteStyle(s lipgloss.Style) Option

+ func WithBoldStyle(s lipgloss.Style) Option

+ func WithBulletChar(c string) Option

+ func WithCodeBlockStyle(s lipgloss.Style) Option

+ func WithCodeInlineStyle(s lipgloss.Style) Option

+ func WithDDStyle(s lipgloss.Style) Option

+ func WithDTStyle(s lipgloss.Style) Option

+ func WithH1Style(s lipgloss.Style) Option

+ func WithH1UnderlineChar(c string) Option

+ func WithH2Style(s lipgloss.Style) Option

+ func WithH2UnderlineChar(c string) Option

+ func WithH3Style(s lipgloss.Style) Option

+ func WithH3UnderlineChar(c string) Option

+ func WithH4Style(s lipgloss.Style) Option

+ func WithH5Style(s lipgloss.Style) Option

+ func WithH6Style(s lipgloss.Style) Option

+ func WithHRChar(c string) Option

+ func WithHRStyle(s lipgloss.Style) Option

+ func WithHRWidth(w int) Option

+ func WithHeadingBarChar(c string) Option

+ func WithItalicStyle(s lipgloss.Style) Option

+ func WithKbdStyle(s lipgloss.Style) Option

+ func WithLinkStyle(s lipgloss.Style) Option

+ func WithListBulletStyle(s lipgloss.Style) Option

+ func WithListItemStyle(s lipgloss.Style) Option

+ func WithMarkStyle(s lipgloss.Style) Option

+ func WithParagraphStyle(s lipgloss.Style) Option

+ func WithSmallStyle(s lipgloss.Style) Option

+ func WithStrikethroughStyle(s lipgloss.Style) Option

+ func WithTheme(t Theme) Option

+ func WithUnderlineStyle(s lipgloss.Style) Option

+ type Theme struct

+ Abbr lipgloss.Style

+ Blockquote lipgloss.Style

+ BlockquoteBar string

+ Bold lipgloss.Style

+ BulletChar string

+ CodeBlock lipgloss.Style

+ CodeInline lipgloss.Style

+ DD lipgloss.Style

+ DT lipgloss.Style

+ H1 lipgloss.Style

+ H1UnderlineChar string

+ H2 lipgloss.Style

+ H2UnderlineChar string

+ H3 lipgloss.Style

+ H3UnderlineChar string

+ H4 lipgloss.Style

+ H5 lipgloss.Style

+ H6 lipgloss.Style

+ HR lipgloss.Style

+ HRChar string

+ HRWidth int

+ HeadingBarChar string

+ Italic lipgloss.Style

+ Kbd lipgloss.Style

+ Link lipgloss.Style

+ ListBullet lipgloss.Style

+ ListItem lipgloss.Style

+ Mark lipgloss.Style

+ Paragraph lipgloss.Style

+ Small lipgloss.Style

+ Strikethrough lipgloss.Style

+ Sub lipgloss.Style

+ Sup lipgloss.Style

+ Underline lipgloss.Style

+ func DefaultTheme() Theme

+ type Typography struct

+ func New(opts ...Option) *Typography

+ func (t *Typography) Abbr(abbr string, desc ...string) string

+ func (t *Typography) Blockquote(text string) string

+ func (t *Typography) Bold(text string) string

+ func (t *Typography) Code(text string) string

+ func (t *Typography) CodeBlock(text string) string

+ func (t *Typography) DD(text string) string

+ func (t *Typography) DL(pairs [][2]string) string

+ func (t *Typography) DT(text string) string

+ func (t *Typography) H1(text string) string

+ func (t *Typography) H2(text string) string

+ func (t *Typography) H3(text string) string

+ func (t *Typography) H4(text string) string

+ func (t *Typography) H5(text string) string

+ func (t *Typography) H6(text string) string

+ func (t *Typography) HR() string

+ func (t *Typography) Italic(text string) string

+ func (t *Typography) Kbd(text string) string

+ func (t *Typography) Link(label string, url ...string) string

+ func (t *Typography) Mark(text string) string

+ func (t *Typography) OL(items ...string) string

+ func (t *Typography) P(text string) string

+ func (t *Typography) Small(text string) string

+ func (t *Typography) Strikethrough(text string) string

+ func (t *Typography) Sub(text string) string

+ func (t *Typography) Sup(text string) string

+ func (t *Typography) Theme() Theme

+ func (t *Typography) UL(items ...string) string

+ func (t *Typography) Underline(text string) string

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