Skip to content

Commit

Permalink
docs: Document that what the diff gutter symbol does (helix-editor#…
Browse files Browse the repository at this point in the history
…9587)

Before there was no document about what the `diff` gutter is displaying
or what the colors mean.

These docs clarify it's a `git` diff and makes it easier to
cross-reference the theme if you aren't sure what the colors mean or
want to change them.
  • Loading branch information
markstos authored and cosmikwolf committed Feb 26, 2024
1 parent 778d9f5 commit 4b1fdc2
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion book/src/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,12 @@ Currently unused

#### `[editor.gutters.diff]` Section

Currently unused
The `diff` gutter option displays colored bars indicating whether a `git` diff represents that a line was added, removed or changed.
These colors are controlled by the theme attributes `diff.plus`, `diff.minus` and `diff.delta`.

Other diff providers will eventually be supported by a future plugin system.

There are currently no options for this section.

#### `[editor.gutters.spacer]` Section

Expand Down

0 comments on commit 4b1fdc2

Please sign in to comment.