No description
Find a file
Christian Rocha 97d11c0065 Bump bubbles for fix where scroll wheel would render extra lines
In particular, the extra lines would be on the top and bottom of the
pager depending on the size of the terminal window.
2020-10-05 13:51:30 +02:00
.github/workflows Remove tests for Go 1.11 and 1.12 (keygen is 1.13 and up) 2020-10-05 13:45:22 +02:00
ui Don't change the state when initializing the Charm client 2020-10-05 13:51:19 +02:00
.gitignore Rename to glow 2019-12-20 22:47:47 +01:00
.goreleaser.yml Fix goreleaser deprecations 2019-12-31 08:31:59 +01:00
console_windows.go Enable ANSI for Windows consoles 2020-01-09 11:38:09 +01:00
example.png Update example image with unicode characters 2020-01-13 12:21:08 -05:00
github.go Make source private 2020-03-31 08:53:35 +02:00
gitlab.go Make source private 2020-03-31 08:53:35 +02:00
glow_test.go Fix tests (don't test glow with no arguments) 2020-10-05 13:45:22 +02:00
go.mod Bump bubbles for fix where scroll wheel would render extra lines 2020-10-05 13:51:30 +02:00
go.sum Bump bubbles for fix where scroll wheel would render extra lines 2020-10-05 13:51:30 +02:00
LICENSE Add LICENSE 2019-12-18 21:33:48 -05:00
main.go Add basic mouse wheel support to pager 2020-10-05 13:47:16 +02:00
Makefile Correct env var placement in Makefile 2020-10-05 13:50:04 +02:00
README.md Add Charm logo, remove SSH stuff 2020-10-05 13:33:39 +02:00
stash.go Add pagination call 2020-10-05 13:35:17 +02:00

Glow

Render markdown on the CLI, with pizzazz!

Glow Logo Latest Release GoDoc Build Status Go ReportCard

Glow example output

Installation

Use your fave package manager:

# macOS or Linux
brew install glow

# Arch Linux (btw)
yay -S glow

# Void Linux
xbps-install -S glow

# Nix
nix-env -iA nixpkgs.glow

# FreeBSD
pkg install glow

Or download a binary from the releases page. Windows, MacOS, and Linux (including ARM) binaries are available, as well as Debian and RPM packages.

Or just use go get:

go get github.com/charmbracelet/glow

Usage

Use a markdown source as the primary argument:

# Read from file
glow README.md

# Read from stdin
glow -

# Fetch README from GitHub / GitLab
glow github.com/charmbracelet/glow

# Fetch markdown from HTTP
glow https://host.tld/file.md

When glow is started without a markdown source, it will try to find a README.md or README file in the current working directory.

Word Wrapping

The -w flag lets you set a maximum width at which the output will be wrapped:

glow -w 60

Paging

The output can be displayed in the user's preferred pager with the -p flag. This defaults to the ANSI-aware less -r if $PAGER is not explicitly set.

Styles

You can choose a style with the -s flag. When no flag is provided glow tries to detect your terminal's current background color and automatically picks either the dark or the light style for you.

glow -s [dark|light]

Alternatively you can also supply a custom JSON stylesheet:

glow -s mystyle.json

Check out the Glamour Style Section to find more styles. Or make your own!


For additional usage details see:

glow --help

License

MIT


Part of Charm.

the Charm logo

Charm热爱开源!