Gold

Render markdown on the CLI, with pizzazz!

What is it?

Gold is a Golang library that allows you to 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.

Usage

See cmd/gold.

Example Output

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!