Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/charmbracelet/glamour

Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️
https://github.com/charmbracelet/glamour

cli go golang hacktoberfest markdown tui

Last synced: 2 months ago
JSON representation

Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️

Host: GitHub
URL: https://github.com/charmbracelet/glamour
Owner: charmbracelet
License: mit
Created: 2019-12-18T23:36:15.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-03-28T23:06:08.000Z (3 months ago)
Last Synced: 2024-03-29T00:22:27.145Z (3 months ago)
Topics: cli, go, golang, hacktoberfest, markdown, tui
Language: Go
Homepage:
Size: 2.52 MB
Stars: 2,071
Watchers: 16
Forks: 156
Open Issues: 99
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Lists

my-awesome-stars - glamour - based markdown rendering for your CLI apps 💇🏻‍♀️ | charmbracelet | 1798 | (Go)
go-awesome - glamour - 命令行下渲染 Markdown (开源类库 / 文本处理)
awesome-golang-repositories - glamour - based markdown rendering for your CLI apps �ｽ�ｽ�ｽ譿�ｿｽ�費ｿｽ蜆ｭ�ｽ (Repositories)
awesome-go - Glamour - Stylesheet-based markdown rendering for your CLI apps (CLI frameworks)
awesome-stars - glamour - based markdown rendering for your CLI apps 💇🏻‍♀️ | charmbracelet | 2190 | (Go)
awesome-trevor - Glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Programming / Golang)
awesome-stars - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
awesome-stars - glamour - based markdown rendering for your CLI apps 💇🏻‍♀️ | charmbracelet | 405 | (Go)
awesome-stars - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (tui)
my-awesome-stars - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
awesome-starred - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (markdown)
awesome-stars - glamour - based markdown rendering for your CLI apps 💇🏻‍♀️ | charmbracelet | 2209 | (Go)
awesome-stars - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
awesome-stars - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
go-awesome - glamour - Render markdown on command line (Open source library / Word Processing)
awesome-x - glamour - based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
awesome-stars - glamour - based markdown rendering for your CLI apps 💇🏻‍♀️ | charmbracelet | 1303 | (Go)
awesome-stars - charmbracelet/glamour - `★2206` Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
go-awesome - glamour - 命令行下渲染 Markdown (开源类库 / 文本处理)
awesome-stars - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
awesome-stars - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
my-stars - charmbracelet/glamour - Stylesheet-based markdown rendering for your CLI apps 💇🏻‍♀️ (Go)
awesome-stars - glamour - based markdown rendering for your CLI apps 💇🏻‍♀️ | charmbracelet | 2206 | (Go)

README

        # Glamour



    


    

    

    

    

    



Stylesheet-based markdown rendering for your CLI apps.

![Glamour dark style example](https://stuff.charm.sh/glamour/glamour-example.png)

`glamour` lets you render [markdown](https://en.wikipedia.org/wiki/Markdown)

documents & templates on [ANSI](https://en.wikipedia.org/wiki/ANSI_escape_code)

compatible terminals. You can create your own stylesheet or simply use one of

the stylish defaults.

## Usage

```go

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

```go

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](https://github.com/charmbracelet/glamour/tree/master/styles/gallery).

Want to create your own style? [Learn how!](https://github.com/charmbracelet/glamour/tree/master/styles)

There are a few options for using a custom style:

1. Call `glamour.Render(inputText, "desiredStyle")`

1. Set the `GLAMOUR_STYLE` environment variable to your desired default style or a file location for a style and call `glamour.RenderWithEnvironmentConfig(inputText)`

1. Set the `GLAMOUR_STYLE` environment variable and pass `glamour.WithEnvironmentConfig()` to your custom renderer

## Glamourous Projects

Check out these projects, which use `glamour`:

- [Glow](https://github.com/charmbracelet/glow), a markdown renderer for

the command-line.

- [GitHub CLI](https://github.com/cli/cli), GitHub’s official command line tool.

- [GitLab CLI](https://gitlab.com/gitlab-org/cli), GitLab's official command line tool.

- [Gitea CLI](https://gitea.com/gitea/tea), Gitea's official command line tool.

- [Meteor](https://github.com/odpf/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](https://twitter.com/charmcli)

* [The Fediverse](https://mastodon.social/@charmcli)

* [Discord](https://charm.sh/chat)

## License

[MIT](https://github.com/charmbracelet/glamour/raw/master/LICENSE)

***

Part of [Charm](https://charm.sh).



Charm热爱开源 • Charm loves open source