Mirrors/glow
2
0
Fork 0
mirror of https://github.com/charmbracelet/glow synced 2024-12-14 22:22:26 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
50 commits 8 branches 20 tags 5 MiB
Go 99.6%
Makefile 0.3%
Dockerfile 0.1%
Find a file
Christian Muehlhaeuser c89ab1c3cb Update default dark style
2019-12-05 14:09:04 +01:00
statik Update default dark style 2019-12-05 14:09:04 +01:00
styles Update default dark style 2019-12-05 14:09:04 +01:00
.goreleaser.yml Add goreleaser config to help automate builds for various platforms 2019-11-24 02:39:02 +01:00
gallery.sh Rename style previews 2019-11-28 09:07:08 +01:00
github.go Handle relative URLs in markdown, when a BaseURL is provided 2019-11-26 00:35:11 +01:00
gitlab.go Handle relative URLs in markdown, when a BaseURL is provided 2019-11-26 00:35:11 +01:00
main.go Render each paragraph individually and reflow text only inside paragraphs 2019-11-28 02:23:29 +01:00
README.md Rename style previews 2019-11-28 09:07:08 +01:00

README.md

Gold

Render markdown on the CLI, with pizzazz!

Usage

Use a markdown source as the argument:

Read from file:

./gold README.md

Read from stdin:

./gold -

Fetch README from GitHub:

./gold github.com/charmbracelet/gold

Fetch markdown from an HTTP source:

./gold https://host.tld/file.md

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

You can supply a JSON stylesheet with the -s flag:

./gold -s mystyle.json

Example Output

Gold Dark Style

Check out the Gold Style Gallery!

Colors

Currently gold uses the Aurora ANSI colors.

Development

Style definitions located in styles/ can be embedded into the binary by running statik:

statik -f -src styles -include "*.json"

You can re-generate screenshots of all available styles by running gallery.sh. This requires termshot and pngcrush installed on your system!