aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNovus Nota2023-12-17 21:40:29 +0000
committerGitHub2023-12-17 21:40:29 +0000
commita1a20d231f509a01b7e0e8e040ce96206276ffd4 (patch)
treef8d487212e6cba96aaa853fcb06f5011160c9035
parentc56cd6ee8b9312a620d4fc38eea90a49613f5d72 (diff)
book: Describe usage of `.ignore` and helix-specific ignore files in `[editor.file-picker]` section (#9102)
-rw-r--r--book/src/configuration.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/book/src/configuration.md b/book/src/configuration.md
index 34be7e8d..03948e2d 100644
--- a/book/src/configuration.md
+++ b/book/src/configuration.md
@@ -177,6 +177,21 @@ All git related options are only enabled in a git repository.
|`git-exclude` | Enables reading `.git/info/exclude` files | `true`
|`max-depth` | Set with an integer value for maximum depth to recurse | Defaults to `None`.
+Ignore files can be placed locally as `.ignore` or put in your home directory as `~/.ignore`. They support the usual ignore and negative ignore (unignore) rules used in `.gitignore` files.
+
+Additionally, you can use Helix-specific ignore files by creating a local `.helix/ignore` file in the current workspace or a global `ignore` file located in your Helix config directory:
+- Linux and Mac: `~/.config/helix/ignore`
+- Windows: `%AppData%\helix\ignore`
+
+Example:
+
+```ini
+# unignore in file picker and global search
+!.github/
+!.gitignore
+!.gitattributes
+```
+
### `[editor.auto-pairs]` Section
Enables automatic insertion of pairs to parentheses, brackets, etc. Can be a