suimeng
/
helix
mirror of https://github.com/helix-editor/helix
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc(auto-reloading): document configuration of auto-reloading

pull/13963/head
Anthony Rubick 2025-07-15 18:54:23 -07:00
parent 1d27b50318
commit 0df5f5f446
No known key found for this signature in database
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
book/src/editor.md
View File

@ -7,6 +7,7 @@
- [`[editor.cursor-shape]` Section](#editorcursor-shape-section) - [`[editor.cursor-shape]` Section](#editorcursor-shape-section)
- [`[editor.file-picker]` Section](#editorfile-picker-section) - [`[editor.file-picker]` Section](#editorfile-picker-section)
- [`[editor.auto-pairs]` Section](#editorauto-pairs-section) - [`[editor.auto-pairs]` Section](#editorauto-pairs-section)
- [`[editor.auto-reload]` Section](#editorauto-reload-section)
- [`[editor.auto-save]` Section](#editorauto-save-section) - [`[editor.auto-save]` Section](#editorauto-save-section)
- [`[editor.search]` Section](#editorsearch-section) - [`[editor.search]` Section](#editorsearch-section)
- [`[editor.whitespace]` Section](#editorwhitespace-section) - [`[editor.whitespace]` Section](#editorwhitespace-section)
@ -264,6 +265,16 @@ name = "rust"
'<' = '>' '<' = '>'
``` ```
### `[editor.auto-reload]` Section
Controls auto reloading of externally modified files.
| Key | Description | Default |
|--|--|---------|
| `focus-gained` | Enable automatic reloading of externally modified files when Helix is focused. Requires [focus event support](https://github.com/helix-editor/helix/wiki/Terminal-Support) from your terminal | `false` |
| `periodic.enable` | Enable periodic auto reloading of externally modified files | `false` |
| `periodic.interval` | Time interval in milliseconds between auto reload checks | `3000` |
### `[editor.auto-save]` Section ### `[editor.auto-save]` Section
Control auto save behavior. Control auto save behavior.