No description
Find a file
Christian Muehlhaeuser e40b04218e Update README
2019-11-25 05:04:17 +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 Support github URLs without protocol 2019-11-25 04:55:54 +01:00
gold_dark.png Add screenshot of dark theme 2019-11-24 05:21:12 +01:00
main.go Support github URLs without protocol 2019-11-25 04:55:54 +01:00
README.md Update README 2019-11-25 05:04:17 +01:00

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 github.com/charmbracelet/gold

Fetch markdown from an HTTP source:

./gold -s dark.json 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.

Colors

Currently gold uses the Aurora ANSI colors.

Example Output

Gold Dark Theme