aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/health.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/health.txt')
-rw-r--r--runtime/doc/health.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/runtime/doc/health.txt b/runtime/doc/health.txt
index cb70961b55..bca145bd8e 100644
--- a/runtime/doc/health.txt
+++ b/runtime/doc/health.txt
@@ -21,6 +21,17 @@ To run all healthchecks, use: >vim
<
Plugin authors are encouraged to write new healthchecks. |health-dev|
+ *g:health*
+g:health This global variable controls the behavior and appearance of the
+ `health` floating window. It should be a dictionary containing the
+ following optional keys:
+ - `style`: string? Determines the display style of the `health` window.
+ Set to `'float'` to enable a floating window. Other
+ styles are not currently supported.
+
+ Example: >lua
+ vim.g.health = { style = 'float' }
+
Commands *health-commands*
*:che* *:checkhealth*