From 00d5e9d815f5d5b1a7111014afb9ca6fa9581e28 Mon Sep 17 00:00:00 2001 From: tjex Date: Sat, 4 Nov 2023 21:04:15 +0100 Subject: doc: file rename --- README.md | 2 +- docs/paths_and_env_vars.md | 25 +++++++++++++++++++++++++ docs/paths_and_environment_variables.md | 25 ------------------------- 3 files changed, 26 insertions(+), 26 deletions(-) create mode 100644 docs/paths_and_env_vars.md delete mode 100644 docs/paths_and_environment_variables.md diff --git a/README.md b/README.md index 7d63a8a..62f3786 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ The full syntax and examples can be found [here](docs/cheatsheet_syntax.md). You can: - [setup your own config file](docs/config_file.md) -- [set custom paths for your config file and cheat sheets](docs/paths_and_environment_variables.md) +- [set custom paths for your config file and cheat sheets](docs/paths_and_env_vars.md) - [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) diff --git a/docs/paths_and_env_vars.md b/docs/paths_and_env_vars.md new file mode 100644 index 0000000..f0cdbb9 --- /dev/null +++ b/docs/paths_and_env_vars.md @@ -0,0 +1,25 @@ +# Paths and Environment Variables + +Navi uses the [`directories-next`](https://crates.io/crates/directories-next) package, which +defines platform-specific standard locations of directories for config, cache and other data. + +Mac users, this is why your files are being stored in `~/Library/Application Support/navi`. + +To set custom paths for your config and cheat sheets, you can set the following +environment variables: + +```zsh +export NAVI_CONFIG="~/.config/navi/config.yaml" +export NAVI_PATH="~/.local/share/navi" +``` +Despite `$NAVI_PATH` being set, it will not be used when installing cheat +sheets directly via navi's own commands. + +For example when running `navi add repo `, the default paths as per the `directories-next` +package will still be used. + +To avoid this, you may simply clone repos via a regular `git clone` command, +directly into `$NAVI_PATH`. + +Note! `navi info cheats-path` and `navi info config-path` display the *default* path, not +the path set by the user. [It is known that this is a little misleading!](https://github.com/denisidoro/navi/issues/664#issuecomment-1004721178). diff --git a/docs/paths_and_environment_variables.md b/docs/paths_and_environment_variables.md deleted file mode 100644 index f0cdbb9..0000000 --- a/docs/paths_and_environment_variables.md +++ /dev/null @@ -1,25 +0,0 @@ -# Paths and Environment Variables - -Navi uses the [`directories-next`](https://crates.io/crates/directories-next) package, which -defines platform-specific standard locations of directories for config, cache and other data. - -Mac users, this is why your files are being stored in `~/Library/Application Support/navi`. - -To set custom paths for your config and cheat sheets, you can set the following -environment variables: - -```zsh -export NAVI_CONFIG="~/.config/navi/config.yaml" -export NAVI_PATH="~/.local/share/navi" -``` -Despite `$NAVI_PATH` being set, it will not be used when installing cheat -sheets directly via navi's own commands. - -For example when running `navi add repo `, the default paths as per the `directories-next` -package will still be used. - -To avoid this, you may simply clone repos via a regular `git clone` command, -directly into `$NAVI_PATH`. - -Note! `navi info cheats-path` and `navi info config-path` display the *default* path, not -the path set by the user. [It is known that this is a little misleading!](https://github.com/denisidoro/navi/issues/664#issuecomment-1004721178). -- cgit v1.2.3