2019-11-15 18:27:41 +00:00
|
|
|
# Gold
|
2019-11-09 22:12:54 +00:00
|
|
|
|
|
|
|
|
Render markdown on the CLI, with _pizzazz_!
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2019-11-22 03:51:44 +00:00
|
|
|
Supply a JSON stylesheet with the `-s` flag. Use a markdown source as the argument.
|
2019-11-09 22:12:54 +00:00
|
|
|
|
2019-11-22 03:51:44 +00:00
|
|
|
Read from file:
|
2019-11-09 22:12:54 +00:00
|
|
|
```
|
|
|
|
|
./gold -s dark.json README.md
|
|
|
|
|
```
|
|
|
|
|
|
2019-11-22 03:51:44 +00:00
|
|
|
Read from stdin:
|
|
|
|
|
```
|
|
|
|
|
./gold -s dark.json -
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Fetch README from GitHub:
|
|
|
|
|
```
|
|
|
|
|
./gold -s dark.json https://github.com/charmbracelet/gold
|
|
|
|
|
```
|
|
|
|
|
|
2019-11-24 04:19:13 +00:00
|
|
|
When `gold` is started without any markdown source, it will try to find a `README.md`
|
|
|
|
|
or `README` file in the current working directory.
|
|
|
|
|
|
2019-11-09 22:12:54 +00:00
|
|
|
## Colors
|
|
|
|
|
|
|
|
|
|
Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index).
|
2019-11-24 04:19:13 +00:00
|
|
|
|
|
|
|
|
## Example Output
|
|
|
|
|
|
|
|
|
|
|
