-
Notifications
You must be signed in to change notification settings - Fork 499
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clearer explanation about .cheat
file paths
#861
Merged
Merged
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
6ab04ce
Update cheatsheet_syntax.md
tapyu 2ae23b8
Update README.md
tapyu eb5c126
Update README.md
tapyu ec1eb7e
Update README.md
tapyu e011114
Update cheatsheet_syntax.md
tapyu df16803
Update cheatsheet_syntax.md
tapyu 96ff6fe
Update cheatsheet_syntax.md
tapyu 6689cfd
Update cheatsheet_syntax.md
tapyu dbd0774
Update cheatsheet_syntax.md
tapyu 0f41e07
Update cheatsheet_syntax.md
tapyu 7accaa4
Rename cheatsheet_syntax.md to cheatsheet_settings.md
tapyu 18c549b
Rename cheatsheet_settings.md to cheatsheet_syntax.md
tapyu 2af6571
Rename config_file.md to navi_config.md
tapyu 924ffb8
Update cheatsheet_syntax.md
tapyu fdc5603
Update navi_config.md
tapyu ef1521f
Update cheatsheet_syntax.md
tapyu 4e1aada
Update cheatsheet_syntax.md
tapyu 3b7f5b9
Delete docs/aliases.md
tapyu ddf6e9c
Update navi_config.md
tapyu 6118a85
Update navi_config.md
tapyu 1180e8c
Update navi_config.md
tapyu 6f16237
Update navi_config.md
tapyu 1119164
Update navi_config.md
tapyu eb9ad7c
Update navi_config.md
tapyu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
This file was deleted.
Oops, something went wrong.
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
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,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 turn 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., | ||
```sh | ||
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 the `.cheat` file paths was not set, the default `.cheat` file paths 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 `%`. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 tonavi_config.md
. It should contain allnavi
config info, whether config file or cheat sheet config.