okami.mom/glamour

git clone https://git.nkp.pet/okami.mom/glamour

Carlos A Beckerfix: do not replace comments with empty linesd5fb104

main
branchesmainall refs →
1.2 KiB47 linesraw
1# Gold
2
3Render markdown on the CLI, with _pizzazz_!
4
5## What is it?
6
7Gold is a Golang library that allows you to use JSON based stylesheets to
8render Markdown files in the terminal. Just like CSS, you can define color and
9style attributes on Markdown elements. The difference is that you use ANSI
10color and terminal codes instead of CSS properties and hex colors.
11
12## Usage
13
14See [cmd/gold](cmd/gold/).
15
16## Example Output
17
18![Gold Dark Style](https://github.com/charmbracelet/gold/raw/master/styles/gallery/dark.png)
19
20Check out the [Gold Style Gallery](https://github.com/charmbracelet/gold/blob/master/styles/gallery/README.md)!
21
22## Colors
23
24Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index).
25
26<!-- comments should be ignored -->
27
28## Development
29
30Style definitions located in `styles/` can be embedded into the binary by
31running [statik](https://github.com/rakyll/statik):
32
33```console
34statik -f -src styles -include "*.json"
35```
36
37<!--
38multiline comments should also be ignored
39this is one comment with
40more than one
41line
42
43yup
44-->
45
46You can re-generate screenshots of all available styles by running `gallery.sh`.
47This requires `termshot` and `pngcrush` installed on your system!