Git
/
gitea-tea
mirror of https://gitea.com/gitea/tea.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gitea-tea/vendor/github.com/charmbracelet/glamour
History
Norwin d2295828d0 Fix resolving of URLs in markdown (#401) 
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>
 		2021-12-03 02:59:02 +08:00
..
ansi Fix resolving of URLs in markdown (#401) 2021-12-03 02:59:02 +08:00
.gitignore Use glamour and termev to render/colorize content (#181) 2020-09-19 16:00:50 +00:00
.golangci.yml Detect markdown line width, resolve relative URLs (#332) 2021-03-12 20:28:46 +08:00
LICENSE Use glamour and termev to render/colorize content (#181) 2020-09-19 16:00:50 +00:00
README.md Fix resolving of URLs in markdown (#401) 2021-12-03 02:59:02 +08:00
examples.sh Use glamour and termev to render/colorize content (#181) 2020-09-19 16:00:50 +00:00
gallery.sh Use glamour and termev to render/colorize content (#181) 2020-09-19 16:00:50 +00:00
glamour.go Fix resolving of URLs in markdown (#401) 2021-12-03 02:59:02 +08:00
go.mod Update Dependencies (#390) 2021-08-30 23:18:50 +08:00
go.sum Update Dependencies (#390) 2021-08-30 23:18:50 +08:00
styles.go Use glamour and termev to render/colorize content (#181) 2020-09-19 16:00:50 +00:00

README.md

Glamour

Glamour Title Treatment
Latest Release GoDoc Build Status Coverage Status Go ReportCard

Write handsome command-line tools with Glamour.

Glamour dark style example

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

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:

  1. Call glamour.Render(inputText, "desiredStyle")
  2. Set the GLAMOUR_STYLE environment variable to your desired default style or a file location for a style and call glamour.RenderWithEnvironmentConfig(inputText)
  3. 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.

The Charm logo

Charm热爱开源 • Charm loves open source