c0fd593c00
* Use GitHub Actions badge in README * Use badge for build workflow * Rename default workflow to build
2.4 KiB
Glow
Render markdown on the CLI, with pizzazz!
Installation
Use your fave package manager:
# MacOS
brew install charmbracelet/homebrew-tap/glow
# Arch Linux (btw)
yay -S 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 (dark being the default):
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
Authors
Part of Charm. For more info see ssh charm.sh