Gold

Render markdown on the CLI, with pizzazz!

What is it?

A Go library that lets you use JSON-based stylesheets to render Markdown files in the terminal. Just like CSS, you can define color and style attributes on Markdown elements. The difference is that you use ANSI color and terminal codes instead of CSS properties and hex colors.

Available as a library and on the CLI.

Example Output

Check out the Gold Style Gallery!

CLI Usage

See cmd/gold.

Colors

Currently gold uses the Aurora ANSI colors.

Development

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

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

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