Skip to content

Commit

Permalink
book: Describe usage of .ignore and helix-specific ignore files in …
Browse files Browse the repository at this point in the history
…`[editor.file-picker]` section (helix-editor#9102)
  • Loading branch information
novusnota authored and Schuyler Mortimer committed Jul 10, 2024
1 parent 68e84b8 commit e453e41
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions book/src/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e453e41

Please sign in to comment.