From 6a884d13889fec578f6af713e7b3aeef7a6a8924 Mon Sep 17 00:00:00 2001
From: Johannes Agricola <naseschwarz@users.noreply.github.com>
Date: Sat, 22 Mar 2025 19:43:43 +0100
Subject: [PATCH] Consolidate recent theme change docs in THEMES.md (#2575)

---
 THEMES.md | 32 +++++++++++++++++++++++++++++---
 1 file changed, 29 insertions(+), 3 deletions(-)

diff --git a/THEMES.md b/THEMES.md
index 0dc92cef..52c235b4 100644
--- a/THEMES.md
+++ b/THEMES.md
@@ -3,6 +3,8 @@
 default on light terminal:
 ![](assets/light-theme.png)
 
+## Configuration
+
 To change the colors of the default theme you need to add a `theme.ron` file that contains the colors you want to override. Note that you don’t have to specify the full theme anymore (as of 0.23). Instead, it is sufficient to override just the values that you want to differ from their default values.
 
 The file uses the [Ron format](https://github.com/ron-rs/ron) and is located at one of the following paths, depending on your operating system:
@@ -16,7 +18,7 @@ Alternatively, you can create a theme in the same directory mentioned above and
 
 Example theme override:
 
-```
+```ron
 (
     selection_bg: Some("Blue"),
     selection_fg: Some("#ffffff"),
@@ -32,11 +34,35 @@ Notes:
 * valid colors can be found in ratatui's [Color](https://docs.rs/ratatui/latest/ratatui/style/enum.Color.html) struct.
 * all customizable theme elements can be found in [`style.rs` in the `impl Default for Theme` block](https://github.com/gitui-org/gitui/blob/master/src/ui/style.rs#L305)
 
+## Preset Themes
+
+You can find preset themes by Catppuccin [here](https://github.com/catppuccin/gitui.git).
+
+## Syntax Highlighting
+
+The syntax highlighting theme can be defined using the element `syntax`. Both [default themes of the syntect library](https://github.com/trishume/syntect/blob/7fe13c0fd53cdfa0f9fea1aa14c5ba37f81d8b71/src/dumps.rs#L215) and custom themes are supported.
+
+Example syntax theme:
+```ron
+(
+    syntax: Some("InspiredGitHub"),
+)
+```
+
+Custom themes are located in the [configuration directory](#configuration), are using TextMate's theme format and must have a `.tmTheme` file extension. To load a custom theme, `syntax` must be set to the file name without the file extension. For example, to load [`Blackboard.tmTheme`](https://raw.githubusercontent.com/filmgirl/TextMate-Themes/refs/heads/master/Blackboard.tmTheme), place the file next to `theme.ron` and set:
+```ron
+(
+    syntax: Some("Blackboard"),
+)
+```
+
+[filmgirl/TextMate-Themes](https://github.com/filmgirl/TextMate-Themes) offers many [beautiful](https://inkdeep.github.io/TextMate-Themes) TextMate themes to choose from.
+
 ## Customizing line breaks
 
 If you want to change how the line break is displayed in the diff, you can also specify `line_break` in your `theme.ron`:
 
-```
+```ron
 (
     line_break: Some("¶"),
 )
@@ -44,7 +70,7 @@ If you want to change how the line break is displayed in the diff, you can also
 
 Note that if you want to turn it off, you should use a blank string:
 
-```
+```ron
 (
     line_break: Some(""),
 )