From df4c60e36c086b5aeb04524e575068f1a58ee32f Mon Sep 17 00:00:00 2001 From: Bennet Bo Fenner Date: Tue, 28 May 2024 14:41:39 +0200 Subject: [PATCH] docs: Indent guides (#12373) Release Notes: - N/A --- docs/src/configuring-zed.md | 68 +++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/docs/src/configuring-zed.md b/docs/src/configuring-zed.md index 4f8a7d9d1a..63ddca3df6 100644 --- a/docs/src/configuring-zed.md +++ b/docs/src/configuring-zed.md @@ -713,6 +713,74 @@ To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files } ``` +### Indent Guides + +- Description: Configuration related to indent guides (requires Zed `0.138.0`). Indent guides can be configured separately for each language. +- Setting: `indent_guides` +- Default: + +```json +{ + "indent_guides": { + "enabled": true, + "line_width": 1, + "coloring": "fixed", + "background_coloring": "disabled" + } +} +``` + +**Options** + +1. Disable indent guides + +```json +{ + "indent_guides": { + "enabled": false + } +} +``` + +2. Enable indent guides for a specific language. + +```json +{ + "languages": { + "Python": { + "indent_guides": { + "enabled": true + } + } + } +} +``` + +3. Enable indent aware coloring ("rainbow indentation"). +The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides. + +```json +{ + "indent_guides": { + "enabled": true, + "coloring": "indent_aware" + } +} +``` + +4. Enable indent aware background coloring ("rainbow indentation"). +The colors that are used for different indentation levels are defined in the theme (theme key: `accents`). They can be customized by using theme overrides. + +```json +{ + "indent_guides": { + "enabled": true, + "coloring": "indent_aware", + "background_coloring": "indent_aware" + } +} +``` + ### Inline Git Blame - Description: Whether or not to show git blame information inline, on the currently focused line (requires Zed `0.132.0`).