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! 💅🏻
20 commits 11 branches 24 tags 17 MiB
  • Go 99.9%
  • Dockerfile 0.1%
Find a file
Christian Muehlhaeuser f09d2907bd Use a plain-text renderer when not printing to Terminal
2019-11-25 04:32:24 +01:00
.goreleaser.yml Add goreleaser config to help automate builds for various platforms 2019-11-24 02:39:02 +01:00
dark.json Use ElementStyles to determine rendering style 2019-11-24 23:33:25 +01:00
github.go Find README(.md) in current working dir when no arg was supplied 2019-11-24 05:07:14 +01:00
gold_dark.png Add screenshot of dark theme 2019-11-24 05:21:12 +01:00
main.go Use a plain-text renderer when not printing to Terminal 2019-11-25 04:32:24 +01:00
README.md Add screenshot of dark theme 2019-11-24 05:21:12 +01:00

README.md

Gold

Render markdown on the CLI, with pizzazz!

Usage

Supply a JSON stylesheet with the -s flag. Use a markdown source as the argument.

Read from file:

./gold -s dark.json README.md

Read from stdin:

./gold -s dark.json -

Fetch README from GitHub:

./gold -s dark.json https://github.com/charmbracelet/gold

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

Colors

Currently gold uses the Aurora ANSI colors.

Example Output

Gold Dark Theme