ceos/glow
1
0
Fork 0
mirror of https://github.com/charmbracelet/glow.git synced 2026-08-26 18:14:17 +02:00
Code Issues Projects Releases Packages Wiki Activity
Render markdown on the CLI, with pizzazz! 💅🏻
65 commits 11 branches 24 tags 17 MiB
  • Go 99.9%
  • Dockerfile 0.1%
Find a file
Christian Muehlhaeuser 68a2909669 Add godoc comments to public types
2019-12-10 17:18:59 +01:00
.goreleaser.yml Add goreleaser config to help automate builds for various platforms 2019-11-24 02:39:02 +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 Add godoc comments to public types 2019-12-10 17:18:59 +01:00
README.md Move gallery and images to styles/gallery/ 2019-12-07 05:08:51 +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.