mirror of
https://gitea.com/gitea/tea.git
synced 2024-11-23 11:01:36 +01:00
89e93d90b3
Merge branch 'master' into use-glamour select Glamour Theme based on BackgroundColor Merge branch 'master' into use-glamour Merge branch 'master' into use-glamour update termev update go.mod label color colorate use glamour for issue content Vendor: Add glamour Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/tea/pulls/181 Reviewed-by: techknowlogick <techknowlogick@gitea.io> Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> |
||
---|---|---|
.. | ||
ansi | ||
.gitignore | ||
examples.sh | ||
gallery.sh | ||
glamour.go | ||
go.mod | ||
go.sum | ||
LICENSE | ||
README.md | ||
styles.go |
Glamour
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 callglamour.RenderWithEnvironmentConfig(inputText)
- Set the
GLAMOUR_STYLE
environment variable and passglamour.WithEnvironmentConfig()
to your custom renderer
Glamourous Projects
Check out Glow, a markdown renderer for
the command-line, which uses glamour
.