Glamour

Glamour is designed to be pure and does not automatically detect terminal color capabilities. To ensure colors are downsampled correctly for the user's terminal, pass the rendered output through lipgloss.Print.

import (
    "charm.land/glamour/v2"
    "charm.land/lipgloss/v2"
)

r, _ := glamour.NewTermRenderer(
    // wrap output at specific width (default is 80)
    glamour.WithWordWrap(40),
)

out, err := r.Render(in)
if err != nil {
    // handle error
}

// downsample colors based on terminal capabilities.
lipgloss.Print(out)

The code_block element can be styled to use specific syntax highlighting themes from Chroma.

Use the theme attribute to define the theme name.

"code_block": {
    "color": "200",
    "theme": "solarized-dark"
}

You can control which stylesheet is used by setting the GLAMOUR_STYLE environment variable. This variable can point to a built-in style name or a file location for a custom style.

Ways to apply this:

1. Use glamour.Render(inputText, "desiredStyle") for direct style selection.
2. Use glamour.RenderWithEnvironmentConfig(inputText) to respect the GLAMOUR_STYLE environment variable.
3. Pass glamour.WithEnvironmentConfig() to a custom renderer created via glamour.NewTermRenderer to respect the GLAMOUR_STYLE environment variable.

The task element allows you to customize the prefixes used for finished and unfinished tasks in Markdown.

"task": {
    "ticked": "✓ ",
    "unticked": "✗ "
}

"cannot find package"

Ensure you have updated your go.mod and that all imports use the new path with /v2:

go get charm.land/glamour/v2

"Colors look wrong"

If colors are not displaying correctly, ensure you are using lipgloss.Print() instead of fmt.Print() to handle color downsampling:

out, _ := r.Render(markdown)
lipgloss.Print(out) // Correct

"Text wrapping issues"

Glamour v2 includes improved text wrapping for CJK characters and emojis. If you encounter wrapping regressions, please open an issue on GitHub.

Use glamour.Render to quickly render markdown text using one of the built-in styles (e.g., "dark"). This is the simplest way to get ANSI-compatible markdown output.

import "charm.land/glamour/v2"

in := `# Hello World

This is a simple example of Markdown rendering with Glamour!
Check out the [other examples](https://github.com/charmbracelet/glamour/tree/main/examples) too.

Bye!
`

out, err := glamour.Render(in, "dark")
fmt.Print(out)

For more control, use glamour.NewTermRenderer to create a renderer instance. This allows you to pass configuration options like glamour.WithWordWrap to control output behavior, such as the line wrap width.

import "charm.land/glamour/v2"

r, _ := glamour.NewTermRenderer(
    // wrap output at specific width (default is 80)
    glamour.WithWordWrap(40),
)

out, err := r.Render(in)
fmt.Print(out)