3.2 KiB

Raw Blame History

Glamour

Glamour Title Treatment

Write handsome command-line tools with glamour!

glamour lets you render markdown documents & templates on ANSI compatible terminals. You can create your own stylesheet or use one of our glamourous default themes.

Usage

import "github.com/charmbracelet/glamour"

in := `# Hello World

This is a simple example of glamour!
Check out the [other examples](https://github.com/charmbracelet/glamour/tree/master/examples).

Bye!
`

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

Custom Renderer

import "github.com/charmbracelet/glamour"

r, _ := glamour.NewTermRenderer(
    // detect background color and pick either the default dark or light theme
    glamour.WithAutoStyle(),
    // wrap output at specific width
    glamour.WithWordWrap(40),
)

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

Styles

You can find all available default styles in our gallery. Want to create your own style? Learn how!

There are a few options for using a custom style:

Call glamour.Render(inputText, "desiredStyle")
Set the GLAMOUR_STYLE environment variable to your desired default style or a file location for a style and call glamour.RenderWithEnvironmentConfig(inputText)
Set the GLAMOUR_STYLE environment variable and pass glamour.WithEnvironmentConfig() to your custom renderer

Glamourous Projects

Check out these projects, which use glamour:

Glow, a markdown renderer for the command-line.
GitHub CLI, GitHub’s official command line tool.
GLab, An open source GitLab command line tool.

License

MIT

Part of Charm.

Charm热爱开源! / Charm loves open source!

3.2 KiB Raw Blame History Unescape Escape