Added documentation for prettybat

This commit is contained in:
Ethan P 2019-06-21 14:48:37 -07:00
parent 147c823c1d
commit b1bf3d1431
No known key found for this signature in database
GPG Key ID: 1F8DF8091CD46FBC
2 changed files with 33 additions and 0 deletions

View File

@ -7,6 +7,7 @@ Bash scripts that integrate [bat](https://github.com/sharkdp/bat) with various c
## Scripts
- [`batgrep`](doc/batgrep.md) (ripgrep + bat)
- [`prettybat`](doc/prettybat.md) (prettier + bat)
 

32
doc/prettybat.md Normal file
View File

@ -0,0 +1,32 @@
# bat-extras: prettybat
A script that uses [prettier](https://github.com/burntsushi/ripgrep) for reformatting and bat for syntax highlighting.
## Command Line
**Synopsis:**
- `prettybat [OPTIONS] [PATH...] `
**Options:**
Every option is passed through to `bat`.
See `man bat` for more information.
## Caveats
The header displayed by bat will show `STDIN` instead of the filename.
There's nothing that can be done about this with the current version of bat.
## Issues?
If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!
Contributions are always welcome.