v0.10.0

Compare Source

Actually readable tables

Big tables that included links were always hard to read. Links can be very long, and tables often have limited space to render them. This means that links often took the space of many lines and weren't properly clickable because they were being truncated in practice.

Starting on this release, Glamour will render links and images at the footer of the table, with a reference number so you can easily find the link you're looking for. If you want the old behavior, it is still supported via the new WithInlineTableLinks option.

The New Way

The Old Way

Wanna render tables with inline links? You still can:

r, err := glamour.NewTermRenderer(glamour.WithInlineTableLinks(true))
if err != nil { /*...*/ }

out, err := r.RenderBytes(in)
if err != nil { /*...*/ }

fmt.Fprintf(os.Stdout, "%s\n", out)

Prettier GitHub links

We also introduced a change so that GitHub links inside tables that reference issues, discussions or PRs will be shown in its shortened form, similar to how GitHub itself present the links on issue descriptions: owner/repo#123.

Extra

Also, we introduced WithTableWrap, so you can disable table text wrapping if really want:

r, err := glamour.NewTermRenderer(glamour.WithTableWrap(false))
if err != nil { ... }

out, err := r.RenderBytes(in)
if err != nil { ... }

fmt.Fprintf(os.Stdout, "%s\n", out)

Changelog

New Features

• 61cfc45: feat(table): add ability to render links at the bottom (@​andreynering)
• 9d87373: feat(table): pad position on table link list (@​andreynering)
• 42f47a2: feat(table): prefix all links with the position in the footer (@​andreynering)
• a11e9a0: feat(table): show position of link also inside the table (@​andreynering)
• 549f544: feat(table): update lipgloss + add WithTableWrap setting (@​andreynering)
• c9af045: feat(tables): format github links inside tables in a more readable manner (@​andreynering)
• f2eb484: feat: add autolink package with patterns for more readable github urls (@​andreynering)

Bug fixes

• 61ff598: fix(links): fix regression of auto links rendering twice (#​415) (@​andreynering)
• 6c48e09: fix: address linting issues after golangci-lint v2 update (@​andreynering)
• 5437e4a: fix: ensure that prop is always cleared (@​andreynering)

Other work

• 6b09916: ci: sync golangci-lint config (#​414) (@​github-actions[bot])
• 9dfd865: lint: fix linting for unused parameter (@​andreynering)

Thoughts? Questions? We love hearing from you. Feel free to reach out on Twitter, The Fediverse, or on Discord.