From a6c87627a9e74553fce1ec20f627b261e4586d90 Mon Sep 17 00:00:00 2001
From: farwyler <1705805+farwyler@users.noreply.github.com>
Date: Tue, 14 Jun 2022 15:44:18 +0200
Subject: [PATCH] adds dimming documentation

---
 book/src/configuration.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/book/src/configuration.md b/book/src/configuration.md
index 4d7e440a09fe0..8d2374082fab3 100644
--- a/book/src/configuration.md
+++ b/book/src/configuration.md
@@ -167,3 +167,25 @@ nbsp = "⍽"
 tab = "→"
 newline = "⏎"
 ```
+
+### `[editor.dim]` Section
+
+Enable dimming in certain areas. Disabled by default. Enable by assigning:
+- 0 = set text modifier flag DIM
+- negative value = darken colors (-127 = 100% darker)
+- positive value = lighten colors (+127 = 100% lighter)
+
+> darken/lighten colors only works with themes that set rgb colors, not indexed colors.
+
+| Key | Description | Default |
+|--|--|---------|
+| `overlay-backdrops` | Enable dimming and set shade of content behind overlays. | `None` |
+| `unfocused-views`| Enable dimming and set shade of unfocused editor views. | `None` |
+
+```toml
+[editor.dim]
+# darken backdrop of overlays
+overlay-backdrops = -25
+# dim fg color of unfocused views
+unfocused-views = 0
+```