on master help sign in
book: Describe usage of `.ignore` and helix-specific ignore files in `[editor.file-picker]` section (#9102)
commita1a20d231f509a01b7e0e8e040ce96206276ffd4 authorNovus Nota <68142933+novusnota@users.noreply.github.com> dateSun 17 Dec 2023, 22:40 (3 years ago) parentc56cd6e
1 file changed+15
book/src/configuration.md+15
book/src/configuration.md+15
@@ -177,6 +177,21 @@ All git related options are only enabled in a git repository.
177177|`git-exclude` | Enables reading `.git/info/exclude` files | `true`
178178|`max-depth` | Set with an integer value for maximum depth to recurse | Defaults to `None`.
179179
180+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.
181+
182+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:
183+- Linux and Mac: `~/.config/helix/ignore`
184+- Windows: `%AppData%\helix\ignore`
185+
186+Example:
187+
188+```ini
189+# unignore in file picker and global search
190+!.github/
191+!.gitignore
192+!.gitattributes
193+```
194+
180195### `[editor.auto-pairs]` Section
181196
182197Enables automatic insertion of pairs to parentheses, brackets, etc. Can be a