From e453e41225927a76b7476b943766f76c9bc09786 Mon Sep 17 00:00:00 2001 From: Novus Nota <68142933+novusnota@users.noreply.github.com> Date: Sun, 17 Dec 2023 22:40:29 +0100 Subject: [PATCH] book: Describe usage of `.ignore` and helix-specific ignore files in `[editor.file-picker]` section (#9102) --- book/src/configuration.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/book/src/configuration.md b/book/src/configuration.md index 34be7e8d724e..03948e2da317 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