Write some amount of documentation

This commit is contained in:
2026-01-31 01:46:18 +01:00
parent e1c4987db5
commit 8cd0ec92c0
57 changed files with 2096 additions and 198 deletions

View File

@@ -422,11 +422,11 @@ impl ThemeColors {
(166, 227, 161), // Green
],
link_dim: [
(70, 55, 85), // Mauve dimmed
(85, 65, 80), // Pink dimmed
(85, 60, 45), // Peach dimmed
(45, 75, 80), // Sky dimmed
(55, 80, 55), // Green dimmed
(70, 55, 85), // Mauve dimmed
(85, 65, 80), // Pink dimmed
(85, 60, 45), // Peach dimmed
(45, 75, 80), // Sky dimmed
(55, 80, 55), // Green dimmed
],
},
header: HeaderColors {
@@ -799,10 +799,7 @@ impl ThemeColors {
key: peach,
text: overlay1,
},
view_badge: ViewBadgeColors {
bg: text,
fg: base,
},
view_badge: ViewBadgeColors { bg: text, fg: base },
nav: NavColors {
selected_bg: Color::Rgb(215, 205, 245),
selected_fg: text,
@@ -923,21 +920,21 @@ impl ThemeColors {
pub fn nord() -> Self {
// Nord color palette
let polar_night0 = Color::Rgb(46, 52, 64); // nord0
let polar_night1 = Color::Rgb(59, 66, 82); // nord1
let polar_night2 = Color::Rgb(67, 76, 94); // nord2
let polar_night3 = Color::Rgb(76, 86, 106); // nord3
let polar_night0 = Color::Rgb(46, 52, 64); // nord0
let polar_night1 = Color::Rgb(59, 66, 82); // nord1
let polar_night2 = Color::Rgb(67, 76, 94); // nord2
let polar_night3 = Color::Rgb(76, 86, 106); // nord3
let snow_storm0 = Color::Rgb(216, 222, 233); // nord4
let _snow_storm1 = Color::Rgb(229, 233, 240); // nord5
let snow_storm2 = Color::Rgb(236, 239, 244); // nord6
let frost0 = Color::Rgb(143, 188, 187); // nord7 (teal)
let frost1 = Color::Rgb(136, 192, 208); // nord8 (light blue)
let frost2 = Color::Rgb(129, 161, 193); // nord9 (blue)
let _frost3 = Color::Rgb(94, 129, 172); // nord10 (dark blue)
let aurora_red = Color::Rgb(191, 97, 106); // nord11
let frost0 = Color::Rgb(143, 188, 187); // nord7 (teal)
let frost1 = Color::Rgb(136, 192, 208); // nord8 (light blue)
let frost2 = Color::Rgb(129, 161, 193); // nord9 (blue)
let _frost3 = Color::Rgb(94, 129, 172); // nord10 (dark blue)
let aurora_red = Color::Rgb(191, 97, 106); // nord11
let aurora_orange = Color::Rgb(208, 135, 112); // nord12
let aurora_yellow = Color::Rgb(235, 203, 139); // nord13
let aurora_green = Color::Rgb(163, 190, 140); // nord14
let aurora_green = Color::Rgb(163, 190, 140); // nord14
let aurora_purple = Color::Rgb(180, 142, 173); // nord15
Self {
@@ -992,11 +989,11 @@ impl ThemeColors {
(163, 190, 140), // Aurora green
],
link_dim: [
(55, 75, 85), // Frost1 dimmed
(70, 60, 70), // Purple dimmed
(75, 55, 50), // Orange dimmed
(55, 75, 75), // Frost0 dimmed
(60, 75, 55), // Green dimmed
(55, 75, 85), // Frost1 dimmed
(70, 60, 70), // Purple dimmed
(75, 55, 50), // Orange dimmed
(55, 75, 75), // Frost0 dimmed
(60, 75, 55), // Green dimmed
],
},
header: HeaderColors {
@@ -1270,11 +1267,11 @@ impl ThemeColors {
(80, 250, 123), // Green
],
link_dim: [
(75, 60, 95), // Purple dimmed
(95, 55, 80), // Pink dimmed
(95, 70, 50), // Orange dimmed
(55, 90, 95), // Cyan dimmed
(40, 95, 55), // Green dimmed
(75, 60, 95), // Purple dimmed
(95, 55, 80), // Pink dimmed
(95, 70, 50), // Orange dimmed
(55, 90, 95), // Cyan dimmed
(40, 95, 55), // Green dimmed
],
},
header: HeaderColors {
@@ -1481,21 +1478,21 @@ impl ThemeColors {
pub fn gruvbox_dark() -> Self {
// Gruvbox Dark palette
let bg0 = Color::Rgb(40, 40, 40); // #282828
let bg1 = Color::Rgb(60, 56, 54); // #3c3836
let bg2 = Color::Rgb(80, 73, 69); // #504945
let _bg3 = Color::Rgb(102, 92, 84); // #665c54
let fg = Color::Rgb(235, 219, 178); // #ebdbb2
let fg2 = Color::Rgb(213, 196, 161); // #d5c4a1
let fg3 = Color::Rgb(189, 174, 147); // #bdae93
let fg4 = Color::Rgb(168, 153, 132); // #a89984
let red = Color::Rgb(251, 73, 52); // #fb4934
let green = Color::Rgb(184, 187, 38); // #b8bb26
let yellow = Color::Rgb(250, 189, 47); // #fabd2f
let blue = Color::Rgb(131, 165, 152); // #83a598
let bg0 = Color::Rgb(40, 40, 40); // #282828
let bg1 = Color::Rgb(60, 56, 54); // #3c3836
let bg2 = Color::Rgb(80, 73, 69); // #504945
let _bg3 = Color::Rgb(102, 92, 84); // #665c54
let fg = Color::Rgb(235, 219, 178); // #ebdbb2
let fg2 = Color::Rgb(213, 196, 161); // #d5c4a1
let fg3 = Color::Rgb(189, 174, 147); // #bdae93
let fg4 = Color::Rgb(168, 153, 132); // #a89984
let red = Color::Rgb(251, 73, 52); // #fb4934
let green = Color::Rgb(184, 187, 38); // #b8bb26
let yellow = Color::Rgb(250, 189, 47); // #fabd2f
let blue = Color::Rgb(131, 165, 152); // #83a598
let purple = Color::Rgb(211, 134, 155); // #d3869b
let aqua = Color::Rgb(142, 192, 124); // #8ec07c
let orange = Color::Rgb(254, 128, 25); // #fe8019
let aqua = Color::Rgb(142, 192, 124); // #8ec07c
let orange = Color::Rgb(254, 128, 25); // #fe8019
let darker_bg = Color::Rgb(29, 32, 33); // #1d2021
@@ -1551,11 +1548,11 @@ impl ThemeColors {
(184, 187, 38), // Green
],
link_dim: [
(85, 55, 35), // Orange dimmed
(75, 55, 65), // Purple dimmed
(80, 70, 40), // Yellow dimmed
(50, 60, 60), // Blue dimmed
(60, 65, 35), // Green dimmed
(85, 55, 35), // Orange dimmed
(75, 55, 65), // Purple dimmed
(80, 70, 40), // Yellow dimmed
(50, 60, 60), // Blue dimmed
(60, 65, 35), // Green dimmed
],
},
header: HeaderColors {
@@ -1638,10 +1635,7 @@ impl ThemeColors {
key: orange,
text: fg4,
},
view_badge: ViewBadgeColors {
bg: fg,
fg: bg0,
},
view_badge: ViewBadgeColors { bg: fg, fg: bg0 },
nav: NavColors {
selected_bg: Color::Rgb(80, 65, 50),
selected_fg: fg,
@@ -1762,18 +1756,18 @@ impl ThemeColors {
pub fn monokai() -> Self {
// Monokai palette
let bg = Color::Rgb(39, 40, 34); // #272822
let bg_light = Color::Rgb(53, 54, 47); // #35362f
let bg = Color::Rgb(39, 40, 34); // #272822
let bg_light = Color::Rgb(53, 54, 47); // #35362f
let bg_lighter = Color::Rgb(70, 71, 62);
let fg = Color::Rgb(248, 248, 242); // #f8f8f2
let fg = Color::Rgb(248, 248, 242); // #f8f8f2
let fg_dim = Color::Rgb(190, 190, 180);
let comment = Color::Rgb(117, 113, 94); // #75715e
let pink = Color::Rgb(249, 38, 114); // #f92672
let green = Color::Rgb(166, 226, 46); // #a6e22e
let pink = Color::Rgb(249, 38, 114); // #f92672
let green = Color::Rgb(166, 226, 46); // #a6e22e
let yellow = Color::Rgb(230, 219, 116); // #e6db74
let blue = Color::Rgb(102, 217, 239); // #66d9ef
let blue = Color::Rgb(102, 217, 239); // #66d9ef
let purple = Color::Rgb(174, 129, 255); // #ae81ff
let orange = Color::Rgb(253, 151, 31); // #fd971f
let orange = Color::Rgb(253, 151, 31); // #fd971f
let darker_bg = Color::Rgb(30, 31, 26);
@@ -1829,11 +1823,11 @@ impl ThemeColors {
(166, 226, 46), // Green
],
link_dim: [
(90, 40, 60), // Pink dimmed
(70, 55, 90), // Purple dimmed
(85, 60, 35), // Orange dimmed
(50, 75, 85), // Blue dimmed
(60, 80, 40), // Green dimmed
(90, 40, 60), // Pink dimmed
(70, 55, 90), // Purple dimmed
(85, 60, 35), // Orange dimmed
(50, 75, 85), // Blue dimmed
(60, 80, 40), // Green dimmed
],
},
header: HeaderColors {
@@ -1916,10 +1910,7 @@ impl ThemeColors {
key: orange,
text: comment,
},
view_badge: ViewBadgeColors {
bg: fg,
fg: bg,
},
view_badge: ViewBadgeColors { bg: fg, fg: bg },
nav: NavColors {
selected_bg: Color::Rgb(80, 60, 75),
selected_fg: fg,
@@ -2040,11 +2031,11 @@ impl ThemeColors {
pub fn pitch_black() -> Self {
// Pitch Black (OLED) palette - pure black background with high contrast
let bg = Color::Rgb(0, 0, 0); // Pure black
let surface = Color::Rgb(10, 10, 10); // Very subtle surface
let surface2 = Color::Rgb(21, 21, 21); // Slightly visible surface
let border = Color::Rgb(40, 40, 40); // Subtle borders
let fg = Color::Rgb(230, 230, 230); // Bright white text
let bg = Color::Rgb(0, 0, 0); // Pure black
let surface = Color::Rgb(10, 10, 10); // Very subtle surface
let surface2 = Color::Rgb(21, 21, 21); // Slightly visible surface
let border = Color::Rgb(40, 40, 40); // Subtle borders
let fg = Color::Rgb(230, 230, 230); // Bright white text
let fg_dim = Color::Rgb(160, 160, 160);
let fg_muted = Color::Rgb(100, 100, 100);
@@ -2109,11 +2100,11 @@ impl ThemeColors {
(80, 255, 120), // Green
],
link_dim: [
(25, 60, 60), // Cyan dimmed
(50, 35, 65), // Purple dimmed
(60, 45, 20), // Orange dimmed
(25, 50, 70), // Blue dimmed
(25, 65, 35), // Green dimmed
(25, 60, 60), // Cyan dimmed
(50, 35, 65), // Purple dimmed
(60, 45, 20), // Orange dimmed
(25, 50, 70), // Blue dimmed
(25, 65, 35), // Green dimmed
],
},
header: HeaderColors {
@@ -2196,10 +2187,7 @@ impl ThemeColors {
key: orange,
text: fg_muted,
},
view_badge: ViewBadgeColors {
bg: fg,
fg: bg,
},
view_badge: ViewBadgeColors { bg: fg, fg: bg },
nav: NavColors {
selected_bg: Color::Rgb(40, 45, 55),
selected_fg: fg,
@@ -2324,16 +2312,36 @@ impl ThemeColors {
pub mod ui {
use super::*;
pub fn bg() -> Color { get().ui.bg }
pub fn bg_rgb() -> (u8, u8, u8) { get().ui.bg_rgb }
pub fn text_primary() -> Color { get().ui.text_primary }
pub fn text_muted() -> Color { get().ui.text_muted }
pub fn text_dim() -> Color { get().ui.text_dim }
pub fn border() -> Color { get().ui.border }
pub fn header() -> Color { get().ui.header }
pub fn unfocused() -> Color { get().ui.unfocused }
pub fn accent() -> Color { get().ui.accent }
pub fn surface() -> Color { get().ui.surface }
pub fn bg() -> Color {
get().ui.bg
}
pub fn bg_rgb() -> (u8, u8, u8) {
get().ui.bg_rgb
}
pub fn text_primary() -> Color {
get().ui.text_primary
}
pub fn text_muted() -> Color {
get().ui.text_muted
}
pub fn text_dim() -> Color {
get().ui.text_dim
}
pub fn border() -> Color {
get().ui.border
}
pub fn header() -> Color {
get().ui.header
}
pub fn unfocused() -> Color {
get().ui.unfocused
}
pub fn accent() -> Color {
get().ui.accent
}
pub fn surface() -> Color {
get().ui.surface
}
// Constants for backward compatibility
pub const BG: Color = Color::Rgb(30, 30, 46);
@@ -2385,10 +2393,18 @@ pub mod tile {
pub const ACTIVE_SELECTED_BG: Color = Color::Rgb(70, 60, 80);
pub const ACTIVE_IN_RANGE_BG: Color = Color::Rgb(55, 55, 70);
pub const LINK_BRIGHT: [(u8, u8, u8); 5] = [
(203, 166, 247), (245, 194, 231), (250, 179, 135), (137, 220, 235), (166, 227, 161),
(203, 166, 247),
(245, 194, 231),
(250, 179, 135),
(137, 220, 235),
(166, 227, 161),
];
pub const LINK_DIM: [(u8, u8, u8); 5] = [
(70, 55, 85), (85, 65, 80), (85, 60, 45), (45, 75, 80), (55, 80, 55),
(70, 55, 85),
(85, 65, 80),
(85, 60, 45),
(45, 75, 80),
(55, 80, 55),
];
}
@@ -2619,7 +2635,11 @@ pub mod meter {
pub mod sparkle {
pub const COLORS: &[(u8, u8, u8)] = &[
(200, 220, 255), (250, 179, 135), (166, 227, 161), (245, 194, 231), (203, 166, 247),
(200, 220, 255),
(250, 179, 135),
(166, 227, 161),
(245, 194, 231),
(203, 166, 247),
];
}