Clearer explanation about .cheat file paths
#861
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for opening this pull request! |
tapyu
changed the title
.cheat file paths
tapyu
commented
Dec 4, 2023
Comment on lines
-34
to
-37
| ### Folder structure | ||
|
|
||
| It's irrelevant how many files are used to store cheatsheets. They can be all in a single file if you wish, as long as you split them accordingly with lines starting with `%`. | ||
|
|
There was a problem hiding this comment.
This information isn't about the cheat sheet syntax. Rather, it is a information about the navi cheat sheet settings. Therefore, it is lost among the cheatsheet syntax information.
I am proposing to merge this information into the former config_file.md file and rename it to navi_config.md. It should contain all navi config info, whether config file or cheat sheet config.
tapyu
commented
Dec 4, 2023
docs/navi_config.md
Outdated
Comment on lines
1
to
32
| ## Config file path | ||
|
|
||
| The default config file path is set by the `$NAVI_CONFIG`environment variable. If it is not set, it fallbacks to `~/.config/navi/config.yaml`. The command | ||
| ```sh | ||
| navi info config-path | ||
| ``` | ||
| prints which config file path is being used. You can get an config file example by running | ||
| ```sh | ||
| navi info config-example | ||
| ``` | ||
| or by clicking [here](./config_file_example.yaml). To this this example your config file, run | ||
|
|
||
| ```sh | ||
| navi info config-example > "$(navi info config-path)" | ||
| ``` | ||
| ## Cheat sheet paths | ||
|
|
||
| The default `.cheat` files paths are defined in the `$NAVI_PATH` environment variable in a colon-separated list, e.g., | ||
| ``` | ||
| export NAVI_PATH='/path/to/a/dir:/path/to/another/dir:/yet/another/dir' | ||
| ``` | ||
| If this environment variable is unset or if all directories do not exist, `navi` uses that paths defined in its config files. Finally, if there is no config file or if there is no `.cheat` file paths settings there, the default `.cheat` file path fallbacks to `~/.local/share/navi/cheats/`. The command | ||
| ```sh | ||
| navi info cheats-path | ||
| ``` | ||
| prints to you all paths used to search for `.cheat` files. | ||
|
|
||
| You can also add other paths at runtime by running `navi` with the `--path` option and a colon-separed paths list, e.g., | ||
| ```sh | ||
| navi --path '/some/dir:/other/dir' | ||
| ``` | ||
| It's irrelevant the directory structure within each path. They can even be all in a single file if you wish, as long as you split them accordingly with lines starting with `%`. |
There was a problem hiding this comment.
This new file addresses both the navi config cheat sheet settings. I also tried to explain all issues commented on #860. Any correction on my understanding is welcome.
tapyu
commented
Dec 4, 2023
Comment on lines
-1
to
-39
| ## Aliases | ||
|
|
||
| **navi** doesn't have support for aliases as first-class citizens at the moment. | ||
|
|
||
| However, it is trivial to create aliases using **navi** + a few conventions. | ||
|
|
||
| For example, suppose you decide to end some of your commands with `:: <some_alias>`: | ||
|
|
||
| ```bash | ||
| % aliases | ||
|
|
||
| # This is one command :: el | ||
| echo lorem ipsum | ||
|
|
||
| # This is another command :: ef | ||
| echo foo bar | ||
| ``` | ||
|
|
||
| Then, if you use **navi** as a [shell scripting tool](shell_scripting.md), you could add something similar to this in your `.bashrc`-like file: | ||
|
|
||
| ```bash | ||
| navialias() { | ||
| navi --query ":: $1" --best-match | ||
| } | ||
|
|
||
| alias el="navialias el" | ||
| alias ef="navialias ef" | ||
| ``` | ||
|
|
||
| If you don't want to use these conventions, you can even add full comments in your aliases: | ||
|
|
||
| ```bash | ||
| navibestmatch() { | ||
| navi --query "$1" --best-match | ||
| } | ||
|
|
||
| alias el="navibestmatch 'This is one command'" | ||
| alias ef="navibestmatch 'This is another command'" | ||
| ``` |
There was a problem hiding this comment.
Aliasing is also about the cheat sheet syntax. I honestly didn't understand why one has a separate markdown file to address it.
My proposal is to put it into docs/cheatsheet_syntax.md.
|
Congrats on merging your first pull request! |
|
Closing in favor of #864 (had to fix merge conflicts) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #860