diff --git a/docs/src/configuring-zed.md b/docs/src/configuring-zed.md index 68aabc0371..dde9ecf4ce 100644 --- a/docs/src/configuring-zed.md +++ b/docs/src/configuring-zed.md @@ -831,6 +831,185 @@ List of `string` values `boolean` values +## Minimap + +- Description: Settings related to the editor's minimap, which provides an overview of your document. +- Setting: `minimap` +- Default: + +```json +{ + "minimap": { + "show": "never", + "thumb": "always", + "thumb_border": "left_open", + "current_line_highlight": null + } +} +``` + +### Show Mode + +- Description: When to show the minimap in the editor. +- Setting: `show` +- Default: `never` + +**Options** + +1. Always show the minimap: + +```json +{ + "show": "always" +} +``` + +2. Show the minimap if the editor's scrollbars are visible: + +```json +{ + "show": "auto" +} +``` + +3. Never show the minimap: + +```json +{ + "show": "never" +} +``` + +### Thumb Display + +- Description: When to show the minimap thumb (the visible editor area) in the minimap. +- Setting: `thumb` +- Default: `always` + +**Options** + +1. Show the minimap thumb when hovering over the minimap: + +```json +{ + "thumb": "hover" +} +``` + +2. Always show the minimap thumb: + +```json +{ + "thumb": "always" +} +``` + +### Thumb Border + +- Description: How the minimap thumb border should look. +- Setting: `thumb_border` +- Default: `left_open` + +**Options** + +1. Display a border on all sides of the thumb: + +```json +{ + "thumb_border": "full" +} +``` + +2. Display a border on all sides except the left side: + +```json +{ + "thumb_border": "left_open" +} +``` + +3. Display a border on all sides except the right side: + +```json +{ + "thumb_border": "right_open" +} +``` + +4. Display a border only on the left side: + +```json +{ + "thumb_border": "left_only" +} +``` + +5. Display the thumb without any border: + +```json +{ + "thumb_border": "none" +} +``` + +### Current Line Highlight + +- Description: How to highlight the current line in the minimap. +- Setting: `current_line_highlight` +- Default: `null` + +**Options** + +1. Inherit the editor's current line highlight setting: + +```json +{ + "minimap": { + "current_line_highlight": null + } +} +``` + +2. Highlight the current line in the minimap: + +```json +{ + "minimap": { + "current_line_highlight": "line" + } +} +``` + +or + +```json +{ + "minimap": { + "current_line_highlight": "all" + } +} +``` + +3. Do not highlight the current line in the minimap: + +```json +{ + "minimap": { + "current_line_highlight": "gutter" + } +} +``` + +or + +```json +{ + "minimap": { + "current_line_highlight": "none" + } +} +``` + ## Editor Tab Bar - Description: Settings related to the editor's tab bar.