From 0df5f5f446b3aef88c0db447b0b90df442652f52 Mon Sep 17 00:00:00 2001 From: Anthony Rubick <68485672+AnthonyMichaelTDM@users.noreply.github.com> Date: Tue, 15 Jul 2025 18:54:23 -0700 Subject: [PATCH] doc(auto-reloading): document configuration of auto-reloading --- book/src/editor.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/book/src/editor.md b/book/src/editor.md index b264201f5..88b791a7e 100644 --- a/book/src/editor.md +++ b/book/src/editor.md @@ -7,6 +7,7 @@ - [`[editor.cursor-shape]` Section](#editorcursor-shape-section) - [`[editor.file-picker]` Section](#editorfile-picker-section) - [`[editor.auto-pairs]` Section](#editorauto-pairs-section) +- [`[editor.auto-reload]` Section](#editorauto-reload-section) - [`[editor.auto-save]` Section](#editorauto-save-section) - [`[editor.search]` Section](#editorsearch-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 Control auto save behavior.