mirror of
https://github.com/charmbracelet/glow
synced 2024-12-14 22:22:26 +00:00
No description
.gitignore | ||
.goreleaser.yml | ||
example.png | ||
github.go | ||
gitlab.go | ||
go.mod | ||
go.sum | ||
LICENSE | ||
main.go | ||
README.md |
Gold
Render markdown on the CLI, with pizzazz!
Installation
Use your fave package manager:
# MacOS
brew install gold
# Arch Linux (btw)
pacman -S gold
Or just use go get
:
go get github.com/charmbracelet/gold
Usage
Use a markdown source as the primary argument:
# Read from file
gold README.md
# Read from stdin
gold -
# Fetch README from GitHub
gold github.com/charmbracelet/gold
# Fetch markdown from HTTP
gold https://host.tld/file.md
When gold
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:
gold -w 60
Styles
You can choose a style with the -s
flag (dark
being the default):
gold -s [dark|light]
Alternatively you can also supply a custom JSON stylesheet:
gold -s mystyle.json
Check out the Glamour Style Section to find more styles. Or make your own!
For additional usage details see:
gold --help
Authors
Part of Charm. For more info see ssh charm.sh