From 59d7c8997db4173e51d57845d3ef3ccbb726965d Mon Sep 17 00:00:00 2001 From: Rubem Pacelli Date: Mon, 15 Jan 2024 20:30:12 -0300 Subject: Delete docs/customization.md --- docs/customization.md | 40 ---------------------------------------- 1 file changed, 40 deletions(-) delete mode 100644 docs/customization.md diff --git a/docs/customization.md b/docs/customization.md deleted file mode 100644 index ec556a8..0000000 --- a/docs/customization.md +++ /dev/null @@ -1,40 +0,0 @@ -## Customization - -- [Changing colors](#changing-colors) -- [Resizing columns](#resizing-columns) -- [Overriding fzf options](#overriding-fzf-options) - -### 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. -- cgit v1.2.3 From d1baf4604645c391c178442549c7305872728fd0 Mon Sep 17 00:00:00 2001 From: Rubem Pacelli Date: Mon, 15 Jan 2024 20:35:18 -0300 Subject: Update navi_config.md --- docs/navi_config.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/navi_config.md b/docs/navi_config.md index e702307..9032958 100644 --- a/docs/navi_config.md +++ b/docs/navi_config.md @@ -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 @@ -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. -- cgit v1.2.3 From a54d1530ffb7e71d7a799c890f5d2568d5db87ef Mon Sep 17 00:00:00 2001 From: Rubem Pacelli Date: Mon, 15 Jan 2024 20:37:42 -0300 Subject: Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d91e304..dffe2c1 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3