mirror of
https://gitea.com/gitea/tea.git
synced 2024-11-24 11:31:36 +01:00
222d0501df
~~this is semi-blocked by https://github.com/charmbracelet/glamour/pull/96, but behaviour isn't really worse than the previous behaviour (most links work, some are still broken)~~ #### testcase for link resolver ``` tea pr 332 tea checkout 332 && make install && tea pr 332 ``` - [rel](./332) - [abs](/gitea/tea/pulls/332) - [full](https://gitea.com/gitea/tea/pulls/332) Co-authored-by: Norwin Roosen <git@nroo.de> Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: https://gitea.com/gitea/tea/pulls/332 Reviewed-by: 6543 <6543@obermui.de> Reviewed-by: Andrew Thornton <art27@cantab.net> Co-authored-by: Norwin <noerw@noreply.gitea.io> Co-committed-by: Norwin <noerw@noreply.gitea.io>
3.2 KiB
3.2 KiB
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_STYLEenvironment variable to your desired default style or a file location for a style and callglamour.RenderWithEnvironmentConfig(inputText) - Set the
GLAMOUR_STYLEenvironment variable and passglamour.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
Part of Charm.
Charm热爱开源! / Charm loves open source!