Skip to content

Commit

Permalink
Merge pull request #871 from tapyu/master
Browse files Browse the repository at this point in the history
merge `customization.md` into `navi_config.md`
  • Loading branch information
denisidoro committed Jan 16, 2024
2 parents 6968a23 + a54d153 commit a461887
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 43 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ You can:

- [setup your own config file](docs/navi_config.md)
- [set custom paths for your config file and cheat sheets](docs/navi_config.md#paths-and-environment-variables)
- [change colors](docs/customization.md#changing-colors)
- [resize columns](docs/customization.md#resizing-columns)
- [change how search is performed](docs/customization.md#overriding-fzf-options)
- [change colors](docs/navi_config.md#changing-colors)
- [resize columns](docs/navi_config.md#resizing-columns)
- [change how search is performed](docs/navi_config.md#overriding-fzf-options)

## More info

Expand Down
40 changes: 0 additions & 40 deletions docs/customization.md

This file was deleted.

46 changes: 46 additions & 0 deletions docs/navi_config.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
- [Paths and Environment Variables](#paths-and-environment-variables)
- [Config file path](#config-file-path)
- [Cheat sheet paths](#cheat-sheet-paths)
- [Logging](#logging)
- [Customization](#customization)
- [Changing colors](#changing-colors)
- [Resizing columns](#resizing-columns)
- [Overriding fzf options](#overriding-fzf-options)

# Paths and Environment Variables

Navi uses the [`directories-next`](https://crates.io/crates/directories-next) package, which
Expand Down Expand Up @@ -46,3 +55,40 @@ the path set by the user. [It is known that this is a little misleading!](https:
The log file will be created under the same directory where the config locates.

And you can use the `RUST_LOG` env to set the log level, e.g. `RUST_LOG=debug navi`.

# Customization

## Changing colors

You can change the [color scheme](https://github.com/junegunn/fzf/wiki/Color-schemes) by [overriding fzf options](#overriding-fzf-options).

In addition, you can change the text color for each column by properly configuring _navi_'s `config.yaml`. Please check `navi --help` for more instructions.

## Resizing columns

You can change the column widths by properly configuring _navi_'s `config.yaml`. Please check `navi --help` for more instructions.

## Overriding fzf options

Let's say you want to override [$FZF_DEFAULT_OPTS](https://github.com/junegunn/fzf#layout) with `--height 3`.

This can be overridden in the following ways:

```sh
# if you want to override only when selecting snippets
navi --fzf-overrides '--height 3'

# alternatively, using an environment variable in your .bashrc-like file:
export NAVI_FZF_OVERRIDES='--height 3'

# if you want to override only when selecting argument values
navi --fzf-overrides-var '--height 3'

# alternatively, using an environment variable in your .bashrc-like file:
export NAVI_FZF_OVERRIDES_VAR='--height 3'

# if you want to override for all cases
FZF_DEFAULT_OPTS="--height 3" navi
```

In addition, this can be set by properly configuring _navi_'s `config.yaml`. Please check `navi --help` for more instructions.

0 comments on commit a461887

Please sign in to comment.