glamour-temp-MUTN/testdata/readme.test at 0355040608252f8e66f0059d0bd857864a1d2f90

mirror of https://github.com/rwinkhart/glamour-temp-MUTN.git synced 2026-08-28 04:46:29 -04:00

Files

T

Christian Rocha e859bb067c Use margins at the document level (versus indent) in default styles (#67 )

* Use margins at the document level (versus indent) in default styles

* Fix tests per the style changes in the previous commit

2020-05-21 17:03:59 +02:00

33 KiB

Raw Blame History

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 /cmd/gold/.

## Example Output

Image: Gold Dark Style →
https://github.com/charmbracelet/gold/raw/master/styles/gallery/dark.png

Check out the Gold Style Gallery
https://github.com/charmbracelet/gold/blob/master/styles/gallery/README.md!

## Colors

Currently gold uses the Aurora ANSI colors
https://godoc.org/github.com/logrusorgru/aurora#Index.

## Development

Style definitions located in styles/ can be embedded into the binary by
running statik https://github.com/rakyll/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!

33 KiB Raw Blame History

33 KiB

Raw Blame History