Mirrors/glow
2
0
Fork 0
mirror of https://github.com/charmbracelet/glow synced 2025-03-04 14:57:13 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Christian Rocha 2019-12-18 21:36:30 -05:00
parent 3806317029
commit c6aae63d78
No known key found for this signature in database
GPG key ID: D6CC7A16E5878018
1 changed files with 46 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -1,18 +1,32 @@
# Gold, the CLI # Gold
Render markdown on the CLI, with _pizzazz_! Render markdown on the CLI, with _pizzazz_!
## Installation ## Installation
```console Use your fave package manager:
```bash
# MacOS
brew install gold
# Arch Linux (btw)
pacman -S gold
```
Or just use `go get`:
```bash
go get github.com/charmbracelet/gold go get github.com/charmbracelet/gold
``` ```
## Usage ## Usage
Use a markdown source as the primary argument: Use a markdown source as the primary argument:
```console ```bash
# Read from file # Read from file
gold README.md gold README.md
@ -26,14 +40,14 @@ gold github.com/charmbracelet/gold
gold https://host.tld/file.md gold https://host.tld/file.md
``` ```
When `gold` is started without any markdown source, it will try to find a When `gold` is started without a 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.
### 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:
```console ```bash
gold -w 60 gold -w 60
``` ```
@ -41,23 +55,42 @@ gold -w 60
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):
```console ```bash
gold -s [dark|light] gold -s [dark|light]
``` ```
Alternatively you can also supply a custom JSON stylesheet: Alternatively you can also supply a custom JSON stylesheet:
```console ```bash
gold -s mystyle.json gold -s mystyle.json
``` ```
Check out the [Glamour Style Gallery](https://github.com/charmbracelet/glamour/blob/master/styles/gallery/README.md) Check out the [Glamour Style Section](https://github.com/charmbracelet/glamour/blob/master/styles/gallery/README.md)
to find more available styles! to find more styles. Or [make your own](https://github.com/charmbracelet/glamour/tree/master/styles)!
***
For additional usage details see:
```bash
gold --help
```
## Example Output ## Example Output
![Glamour Dark Style](https://github.com/charmbracelet/glamour/raw/master/styles/gallery/dark.png) ![Glamour Dark Style](https://github.com/charmbracelet/gold/raw/master/example.png)
## Colors
Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index). ## Authors
* [Christian Muehlhaeuser](https://github.com/muesli)
* [Toby Padilla](https://github.com/toby)
* [Christian Rocha](https://github.com/meowgorithm)
Part of [Charm](https://charm.sh). For more info see: `ssh charm.sh`
## License
[MIT](https://github.com/charmbracelet/gold/raw/master/LICENSE)