mirror of
https://github.com/rwinkhart/glamour-temp-MUTN.git
synced 2026-08-28 04:46:29 -04:00
48 lines
1.2 KiB
Plaintext
48 lines
1.2 KiB
Plaintext
# 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
|
|
|
|
|
|
|
|
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).
|
|
|
|
<!-- comments should be ignored -->
|
|
|
|
## Development
|
|
|
|
Style definitions located in `styles/` can be embedded into the binary by
|
|
running [statik](https://github.com/rakyll/statik):
|
|
|
|
```console
|
|
statik -f -src styles -include "*.json"
|
|
```
|
|
|
|
<!--
|
|
multiline comments should also be ignored
|
|
this is one comment with
|
|
more than one
|
|
line
|
|
|
|
yup
|
|
-->
|
|
|
|
You can re-generate screenshots of all available styles by running `gallery.sh`.
|
|
This requires `termshot` and `pngcrush` installed on your system!
|