diff --git a/README.md b/README.md index 62be46e..d74323f 100644 --- a/README.md +++ b/README.md @@ -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)   diff --git a/doc/prettybat.md b/doc/prettybat.md new file mode 100644 index 0000000..0708316 --- /dev/null +++ b/doc/prettybat.md @@ -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. +