mirror of
https://gitea.com/Sirherobrine23/tea.git
synced 2024-08-21 17:57:24 +00:00
Path-only URLs need an absolute reference to be resolved against for printing in markdown Previously we resolved against the URL to the resource we were operating on (eg comment or issue URL). The markdown renderer in the web UI resolves all such URLs relative to the repo base URL. This PR adopts this behaviour in tea, by trimming the URL to a repo base URL via regex. This makes a custom patch to our markdown renderer `glamour` obsolete, which turned out to be an incorrect patch, meaning we can make use of upstream glamour again. Co-authored-by: Norwin <git@nroo.de> Reviewed-on: https://gitea.com/gitea/tea/pulls/401 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-by: 6543 <6543@obermui.de> Co-authored-by: Norwin <noerw@noreply.gitea.io> Co-committed-by: Norwin <noerw@noreply.gitea.io>
3.3 KiB
3.3 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 simply use one of
the stylish defaults.
Usage
import "github.com/charmbracelet/glamour"
in := `# Hello World
This is a simple example of Markdown rendering with Glamour!
Check out the [other examples](https://github.com/charmbracelet/glamour/tree/master/examples) too.
Bye!
`
out, err := glamour.Render(in, "dark")
fmt.Print(out)
![Hello World example](https://github.com/charmbracelet/glamour/raw/master/examples/helloworld/helloworld.png)
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 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