From 75e9306c0d490a179b9a583730c74d6e734731e2 Mon Sep 17 00:00:00 2001 From: tjex Date: Sat, 4 Nov 2023 20:53:33 +0100 Subject: [PATCH 1/5] documentation on paths and environment vars --- README.md | 1 + docs/paths_and_environment_variables.md | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 docs/paths_and_environment_variables.md diff --git a/README.md b/README.md index dd04376..a06284b 100644 --- a/README.md +++ b/README.md @@ -90,6 +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) - [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_environment_variables.md b/docs/paths_and_environment_variables.md new file mode 100644 index 0000000..c53e828 --- /dev/null +++ b/docs/paths_and_environment_variables.md @@ -0,0 +1,21 @@ +# 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" +``` +Note! Even when set, `$NAVI_PATH` will not be used when installing cheat +sheets directly via navi's own commands. + +For example when running `navi add repo `~/Library/...` will still be used. + +Instead, you may clone repos directly into `$NAVI_PATH`, or write your own +manually. From 8d19e8aa3c88d0b876577bc90d84ecbedcde1be8 Mon Sep 17 00:00:00 2001 From: tjex Date: Sat, 4 Nov 2023 20:54:49 +0100 Subject: [PATCH 2/5] doc: typo --- docs/paths_and_environment_variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/paths_and_environment_variables.md b/docs/paths_and_environment_variables.md index c53e828..6266266 100644 --- a/docs/paths_and_environment_variables.md +++ b/docs/paths_and_environment_variables.md @@ -15,7 +15,7 @@ export NAVI_PATH="~/.local/share/navi" Note! Even when set, `$NAVI_PATH` will not be used when installing cheat sheets directly via navi's own commands. -For example when running `navi add repo `~/Library/...` will still be used. +For example when running `navi add repo `, `~/Library/...` will still be used. Instead, you may clone repos directly into `$NAVI_PATH`, or write your own manually. From 3b35956a47d506654873ecb2a8cb7755a084e2a8 Mon Sep 17 00:00:00 2001 From: tjex Date: Sat, 4 Nov 2023 20:56:48 +0100 Subject: [PATCH 3/5] docs: clarity --- docs/paths_and_environment_variables.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/paths_and_environment_variables.md b/docs/paths_and_environment_variables.md index 6266266..99eb490 100644 --- a/docs/paths_and_environment_variables.md +++ b/docs/paths_and_environment_variables.md @@ -15,7 +15,8 @@ export NAVI_PATH="~/.local/share/navi" Note! Even when set, `$NAVI_PATH` will not be used when installing cheat sheets directly via navi's own commands. -For example when running `navi add repo `, `~/Library/...` will still be used. +For example when running `navi add repo `, the default paths as per the `directories-next` +package will still be used. -Instead, you may clone repos directly into `$NAVI_PATH`, or write your own -manually. +To avoid this, you may simply clone repos via a regular `git clone` command, +directly into `$NAVI_PATH`. From 0dd7b4c9f2d64ccb95707066445a85e4f1ee501e Mon Sep 17 00:00:00 2001 From: tjex Date: Sat, 4 Nov 2023 21:03:10 +0100 Subject: [PATCH 4/5] docs: extra clarity --- docs/paths_and_environment_variables.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/paths_and_environment_variables.md b/docs/paths_and_environment_variables.md index 99eb490..f0cdbb9 100644 --- a/docs/paths_and_environment_variables.md +++ b/docs/paths_and_environment_variables.md @@ -12,7 +12,7 @@ environment variables: export NAVI_CONFIG="~/.config/navi/config.yaml" export NAVI_PATH="~/.local/share/navi" ``` -Note! Even when set, `$NAVI_PATH` will not be used when installing cheat +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` @@ -20,3 +20,6 @@ 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). From d036487fbca9524b1849f09db1b4061cb3519080 Mon Sep 17 00:00:00 2001 From: tjex Date: Sat, 4 Nov 2023 21:04:15 +0100 Subject: [PATCH 5/5] doc: file rename --- README.md | 2 +- ...paths_and_environment_variables.md => paths_and_env_vars.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/{paths_and_environment_variables.md => paths_and_env_vars.md} (100%) diff --git a/README.md b/README.md index a06284b..1011b9d 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_environment_variables.md b/docs/paths_and_env_vars.md similarity index 100% rename from docs/paths_and_environment_variables.md rename to docs/paths_and_env_vars.md