Mirrors/glow
2
0
Fork 0
mirror of https://github.com/charmbracelet/glow synced 2025-01-22 16:55:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Link to gallery from related Styles paragraph

Browse source
This commit is contained in:
Christian Muehlhaeuser 2019-12-13 03:29:52 +01:00
parent 73d1d5d061
commit 62eaf39a4f
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -29,16 +29,14 @@ Fetch markdown from an HTTP source:
When `gold` is started without any markdown source, it will try to find a When `gold` is started without any markdown source, it will try to find a
`README.md` or `README` file in the current working directory. `README.md` or `README` file in the current working directory.
### Flags ### Word Wrapping
#### Word Wrapping
The `-w` flag lets you set a maximum width, at which the output will be wrapped: The `-w` flag lets you set a maximum width, at which the output will be wrapped:
``` ```
./gold -w 60 ./gold -w 60
``` ```
#### Styles ### Styles
You can choose a style with the `-s` flag (`dark` being the default): You can choose a style with the `-s` flag (`dark` being the default):
``` ```
@ -50,12 +48,13 @@ Alternatively you can also supply a custom JSON stylesheet:
./gold -s mystyle.json ./gold -s mystyle.json
``` ```
Check out the [Gold Style Gallery](https://github.com/charmbracelet/gold/blob/master/styles/gallery/README.md)
to find more available styles!
## Example Output ## Example Output
![Gold Dark Style](https://github.com/charmbracelet/gold/raw/master/styles/gallery/dark.png) ![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 ## Colors
Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index). Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index).