diff --git a/README.md b/README.md index 016fe83427..364e2da911 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ bat f - g # output 'f', then stdin, then 'g'. #### `fzf` You can use `bat` as a previewer for [`fzf`](https://github.com/junegunn/fzf). To do this, -use `bat`s `--color=always` option to force colorized output. You can also use `--line-range` +use `bat`'s `--color=always` option to force colorized output. You can also use `--line-range` option to restrict the load times for long files: ```bash @@ -473,8 +473,8 @@ Use `bat --list-themes` to get a list of all available themes for syntax highlighting. To select the `TwoDark` theme, call `bat` with the `--theme=TwoDark` option or set the `BAT_THEME` environment variable to `TwoDark`. Use `export BAT_THEME="TwoDark"` in your shell's startup file to -make the change permanent. Alternatively, use `bat`s -[configuration file](https://github.com/sharkdp/bat#configuration-file). +make the change permanent. Alternatively, use `bat`'s +[configuration file](#configuration-file). If you want to preview the different themes on a custom file, you can use the following command (you need [`fzf`](https://github.com/junegunn/fzf) for this): @@ -485,7 +485,7 @@ bat --list-themes | fzf --preview="bat --theme={} --color=always /path/to/file" `bat` looks good on a dark background by default. However, if your terminal uses a light background, some themes like `GitHub` or `OneHalfLight` will work better for you. You can also use a custom theme by following the -['Adding new themes' section below](https://github.com/sharkdp/bat#adding-new-themes). +['Adding new themes' section below](#adding-new-themes). ### 8-bit themes @@ -509,11 +509,11 @@ Although these themes are more restricted, they have three advantages over truec ### Output style -You can use the `--style` option to control the appearance of `bat`s output. +You can use the `--style` option to control the appearance of `bat`'s output. You can use `--style=numbers,changes`, for example, to show only Git changes and line numbers but no grid and no file header. Set the `BAT_STYLE` environment -variable to make these changes permanent or use `bat`s -[configuration file](https://github.com/sharkdp/bat#configuration-file). +variable to make these changes permanent or use `bat`'s +[configuration file](#configuration-file). >[!tip] > If you specify a default style in `bat`'s config file, you can change which components @@ -630,7 +630,7 @@ If you want to pass command-line arguments to the pager, you can also set them v export BAT_PAGER="less -RF" ``` -Instead of using environment variables, you can also use `bat`s [configuration file](https://github.com/sharkdp/bat#configuration-file) to configure the pager (`--pager` option). +Instead of using environment variables, you can also use `bat`'s [configuration file](#configuration-file) to configure the pager (`--pager` option). ### Using `less` as a pager @@ -836,7 +836,7 @@ bash assets/create.sh cargo install --path . --locked --force ``` -If you want to build an application that uses `bat`s pretty-printing +If you want to build an application that uses `bat`'s pretty-printing features as a library, check out the [the API documentation](https://docs.rs/bat/). Note that you have to use either `regex-onig` or `regex-fancy` as a feature when you depend on `bat` as a library.