glamour

README

Glamour

Stylesheet-based markdown rendering for your CLI apps.

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)

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 (default is 80)
    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.
• GitLab CLI, GitLab's official command line tool.
• Gitea CLI, Gitea's official command line tool.
• Meteor, an easy-to-use, plugin-driven metadata collection framework.

Feedback

We’d love to hear your thoughts on this project. Feel free to drop us a note!

• Twitter
• The Fediverse
• Discord

License

MIT

---

Part of Charm.

Charm热爱开源 • Charm loves open source

Documentation

Overview

Package 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

Index

• func Render(in string, stylePath string) (string, error)
• func RenderBytes(in []byte, stylePath string) ([]byte, error)
• func RenderWithEnvironmentConfig(in string) (string, error)
• type TermRenderer
  • func NewTermRenderer(options ...TermRendererOption) (*TermRenderer, error)
  • func (tr *TermRenderer) Close() error
  • func (tr *TermRenderer) Read(b []byte) (int, error)
  • func (tr *TermRenderer) Render(in string) (string, error)
  • func (tr *TermRenderer) RenderBytes(in []byte) ([]byte, error)
  • func (tr *TermRenderer) Write(b []byte) (int, error)
• type TermRendererOption
  • func WithAutoStyle() TermRendererOption
  • func WithBaseURL(baseURL string) TermRendererOption
  • func WithChromaFormatter(formatter string) TermRendererOption
  • func WithColorProfile(profile termenv.Profile) TermRendererOption
  • func WithEmoji() TermRendererOption
  • func WithEnvironmentConfig() TermRendererOption
  • func WithInlineTableLinks(inlineTableLinks bool) TermRendererOption
  • func WithOptions(options ...TermRendererOption) TermRendererOption
  • func WithPreservedNewLines() TermRendererOption
  • func WithStandardStyle(style string) TermRendererOption
  • func WithStylePath(stylePath string) TermRendererOption
  • func WithStyles(styles ansi.StyleConfig) TermRendererOption
  • func WithStylesFromJSONBytes(jsonBytes []byte) TermRendererOption
  • func WithStylesFromJSONFile(filename string) TermRendererOption
  • func WithTableWrap(tableWrap bool) TermRendererOption
  • func WithWordWrap(wordWrap int) TermRendererOption

Functions

func Render

func Render(in string, stylePath string) (string, error)

Render initializes a new TermRenderer and renders a markdown with a specific style.

func RenderBytes

func RenderBytes(in []byte, stylePath string) ([]byte, error)

RenderBytes initializes a new TermRenderer and renders a markdown with a specific style.

func RenderWithEnvironmentConfig

func RenderWithEnvironmentConfig(in string) (string, error)

RenderWithEnvironmentConfig initializes a new TermRenderer and renders a markdown with a specific style defined by the GLAMOUR_STYLE environment variable.

Types

type TermRenderer

type TermRenderer struct {
	// contains filtered or unexported fields
}

TermRenderer can be used to render markdown content, posing a depth of customization and styles to fit your needs.

func NewTermRenderer

func NewTermRenderer(options ...TermRendererOption) (*TermRenderer, error)

NewTermRenderer returns a new TermRenderer the given options.

func (*TermRenderer) Close

func (tr *TermRenderer) Close() error

Close must be called after writing to TermRenderer. You can then retrieve the rendered markdown by calling Read.

func (*TermRenderer) Read

func (tr *TermRenderer) Read(b []byte) (int, error)

func (*TermRenderer) Render

func (tr *TermRenderer) Render(in string) (string, error)

Render returns the markdown rendered into a string.

func (*TermRenderer) RenderBytes

func (tr *TermRenderer) RenderBytes(in []byte) ([]byte, error)

RenderBytes returns the markdown rendered into a byte slice.

func (*TermRenderer) Write

func (tr *TermRenderer) Write(b []byte) (int, error)

type TermRendererOption

type TermRendererOption func(*TermRenderer) error

A TermRendererOption sets an option on a TermRenderer.

func WithAutoStyle

func WithAutoStyle() TermRendererOption

WithAutoStyle sets a TermRenderer's styles with either the standard dark or light style, depending on the terminal's background color at run-time.

func WithBaseURL

func WithBaseURL(baseURL string) TermRendererOption

WithBaseURL sets a TermRenderer's base URL.

func WithChromaFormatter

func WithChromaFormatter(formatter string) TermRendererOption

WithChromaFormatter sets a TermRenderer's chroma formatter used for code blocks.

func WithColorProfile

func WithColorProfile(profile termenv.Profile) TermRendererOption

WithColorProfile sets the TermRenderer's color profile (TrueColor / ANSI256 / ANSI).

func WithEmoji

func WithEmoji() TermRendererOption

WithEmoji sets a TermRenderer's emoji rendering.

func WithEnvironmentConfig

func WithEnvironmentConfig() TermRendererOption

WithEnvironmentConfig sets a TermRenderer's styles based on the GLAMOUR_STYLE environment variable.

func WithInlineTableLinks

func WithInlineTableLinks(inlineTableLinks bool) TermRendererOption

WithInlineTableLinks forces tables to render links inline. By default,links are rendered as a list of links at the bottom of the table.

func WithOptions

func WithOptions(options ...TermRendererOption) TermRendererOption

WithOptions sets multiple TermRenderer options within a single TermRendererOption.

func WithPreservedNewLines

func WithPreservedNewLines() TermRendererOption

WithPreservedNewLines preserves newlines from being replaced.

func WithStandardStyle

func WithStandardStyle(style string) TermRendererOption

WithStandardStyle sets a TermRenderer's styles with a standard (builtin) style.

func WithStylePath

func WithStylePath(stylePath string) TermRendererOption

WithStylePath sets a TermRenderer's style from stylePath. stylePath is first interpreted as a filename. If no such file exists, it is re-interpreted as a standard style.

func WithStyles

func WithStyles(styles ansi.StyleConfig) TermRendererOption

WithStyles sets a TermRenderer's styles.

func WithStylesFromJSONBytes

func WithStylesFromJSONBytes(jsonBytes []byte) TermRendererOption

WithStylesFromJSONBytes sets a TermRenderer's styles by parsing styles from jsonBytes.

func WithStylesFromJSONFile

func WithStylesFromJSONFile(filename string) TermRendererOption

WithStylesFromJSONFile sets a TermRenderer's styles from a JSON file.

func WithTableWrap

func WithTableWrap(tableWrap bool) TermRendererOption

WithTableWrap controls whether table content will wrap if too long. This is true by default. If false, table content will be truncated with an ellipsis if too long to fit.

func WithWordWrap

func WithWordWrap(wordWrap int) TermRendererOption

WithWordWrap sets a TermRenderer's word wrap.