From 1c2abfd8e8d83445d2ca33aa351e419f951d7767 Mon Sep 17 00:00:00 2001 From: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com> Date: Wed, 30 Apr 2025 22:06:38 +0200 Subject: [PATCH] Updates the docs Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com> --- docs/usage/commands/info/README.md | 16 ++++++++-------- docs/usage/commands/repo/README.md | 2 +- docs/usage/fzf-overrides/README.md | 22 +++++++++++++++++++++- docs/usage/shell-scripting/README.md | 12 +++++++++++- 4 files changed, 41 insertions(+), 11 deletions(-) diff --git a/docs/usage/commands/info/README.md b/docs/usage/commands/info/README.md index 5b3d970..9fcdbbf 100644 --- a/docs/usage/commands/info/README.md +++ b/docs/usage/commands/info/README.md @@ -13,14 +13,14 @@ Navi exposes information about its default values or examples for you to use. ## Commands Reference -| Command | Description | -|---------------------|-------------| -| config-path | | -| cheats-path | | -| default-config-path | | -| default-cheats-path | | -| config-example | | -| cheats-example | | +| Command | Description | +|---------------------|----------------------------------------------------| +| config-path | [DEPRECATED] Lets you see the default config path | +| cheats-path | [DEPRECATED] Lets you see the default cheats path | +| default-config-path | Lets you see the default config path | +| default-cheats-path | Lets you see the default cheats path | +| config-example | Lets you see an example for the configuration file | +| cheats-example | Lets you see an example for a cheat file | ## Default configuration information diff --git a/docs/usage/commands/repo/README.md b/docs/usage/commands/repo/README.md index 02e2890..ce83054 100644 --- a/docs/usage/commands/repo/README.md +++ b/docs/usage/commands/repo/README.md @@ -4,7 +4,7 @@ * [The repo subcommands of navi](#the-repo-subcommands-of-navi) * [Commands Reference](#commands-reference) * [Browsing through cheatsheet repositories](#browsing-through-cheatsheet-repositories) -* [Importing cheatsheet repositories](#importing-cheatsheet-repositories) + * [Importing cheatsheet repositories](#importing-cheatsheet-repositories) ## Commands Reference diff --git a/docs/usage/fzf-overrides/README.md b/docs/usage/fzf-overrides/README.md index ea508ff..eecac45 100644 --- a/docs/usage/fzf-overrides/README.md +++ b/docs/usage/fzf-overrides/README.md @@ -1,10 +1,30 @@ +# The FZF Overrides of Navi + +Navi allows you to override certain parts of FZF in multiple ways. + + +* [The FZF Overrides of Navi](#the-fzf-overrides-of-navi) + * [Command line arguments](#command-line-arguments) + * [Environment variables](#environment-variables) + + +## Command line arguments + +Navi allows you to use command line arguments in order to override fzf values: + ```sh # if you want to override only when selecting snippets navi --fzf-overrides '--height 3' # if you want to override only when selecting argument values navi --fzf-overrides-var '--height 3' +``` +## Environment variables + +Navi allows you to use environment variables in order to override fzf values. + +```bash # if you want to override for all cases FZF_DEFAULT_OPTS="--height 3" navi -``` \ No newline at end of file +``` diff --git a/docs/usage/shell-scripting/README.md b/docs/usage/shell-scripting/README.md index 9334f55..3eb8036 100644 --- a/docs/usage/shell-scripting/README.md +++ b/docs/usage/shell-scripting/README.md @@ -2,7 +2,17 @@ You can use Navi with shell scripting. -The following blog post gives you an example of a real world scenario: [denisidoro.github.io/posts/cli-templates/](https://denisidoro.github.io/posts/cli-templates/) + +* [Navi and shell scripting](#navi-and-shell-scripting) + * [Simply calling a cheat](#simply-calling-a-cheat) + * [Defining variables while calling](#defining-variables-while-calling) + * [Filtering results for a variable](#filtering-results-for-a-variable) + * [Selecting the best match for a variable](#selecting-the-best-match-for-a-variable) + + +> [NOTE!] +> The following blog post gives you an example of a real world scenario: [denisidoro.github.io/posts/cli-templates/](https://denisidoro.github.io/posts/cli-templates/) + ## Simply calling a cheat