Host the manual's images in the repo under manual/images (#6861)

* Host the manual's images in the repo under manual/images Replaces all learn.omacom.io/manual.omakub.org hotlinks with local webp files capped at 1600px wide (~20MB total), so the manual is fully self-contained. Theme and unlock previews are converted from the canonical themes/*/preview.png files. A handful of illustration shots are interim conversions of the current images, pending retakes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Retake the illustration screenshots fresh at 3x scaling Navigation, clipboard history, notices, tmux layouts, prompt, and About reshot on a clean workspace at 3.13x (1920x1080 logical on 6K) across ten themes: Tokyo Night, Catppuccin, Gruvbox, Kanagawa, Everforest, Nord, Osaka Jade, Rose Pine, Matte Black, and Ristretto. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Drop the extra themes chapter from the manual The community theme gallery will live elsewhere. Removes the chapter and its 114 gallery images, renumbers the following chapters, and repoints the two references (theme installs still work via Install > Style > Theme in the menu). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Reference the shipped theme previews instead of copying them The themes chapter now points straight at themes/*/preview.png and preview-unlock.png, so previews can never drift from the source and manual/images drops from 6.3MB to 3.5MB. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-14 12:47:38 +02:00
parent 4559f2d5fc
commit e7ea031f98
73 changed files with 97 additions and 442 deletions
@@ -0,0 +1,31 @@
+# Making your own theme
+
+You can add your own themes to `~/.config/omarchy/themes`. Just copy one of the existing ones as a base (look in `/usr/share/omarchy/themes`), then tweak to your delight. As long as your theme is inside that folder, it'll be included in the theme selection menu.
+
+The main file you have to tweak is `colors.toml`. That defines the color set that's then used to generate configurations for the terminal (Foot/Alacritty/Ghostty/Kitty), btop, Chromium, Hyprland, Neovim, Helix, VSCode, Obsidian, and the entire Omarchy shell (top bar, menu, notifications, OSD, and lock screen).
+
+You can also use the included Aether application to create a new theme using a lovely GUI interface to play with colors and search for backgrounds. Just start it via the apps menu on `Super + Alt + Space`.
+
+### Light mode
+
+If you're making a light mode theme, set `mode = "light"` at the top of your `colors.toml`. Then it'll automatically be paired with light mode for all the apps. (The old way of dropping an empty file called `light.mode` in the root of your theme still works too.)
+
+### Icon colors
+
+If you'd like to color-match the file manager icons to your theme, add a file called `icons.theme` with the name of the icon set you want to use. By default, the options are: `Yaru Yaru-blue Yaru-dark Yaru-magenta Yaru-olive Yaru-prussiangreen Yaru-purple Yaru-red Yaru-sage Yaru-wartybrown Yaru-yellow`.
+
+### Unlock image
+
+Themes supplied with `unlock.png` and `preview-unlock.png` images will be listed under _Style > Unlock_. Your `unlock.png` should preferably be a transparent png. And you can create the preview image using `omarchy plymouth preview`.
+
+### Theming apps Omarchy doesn't cover
+
+If you use an app that isn't in that list, you can teach Omarchy to theme it yourself with a template. Drop a file in `~/.config/omarchy/themed/` named after the config it generates plus a `.tpl` extension, and write the config with `{{ background }}`, `{{ foreground }}`, `{{ accent }}`, `{{ red }}`, `{{ color0 }}` through `{{ color15 }}`, and the rest of the palette as placeholders. Every time you switch themes, the file is regenerated with that theme's colors.
+
+There's a fully commented `alacritty.toml.tpl.sample` in that folder to copy from — it lists every variable you can use, plus the `_strip` and `_rgb` modifiers for apps that want their colors without the `#` or as decimal RGB. Your templates take priority over Omarchy's own, so you can also use this to override how a built-in app gets themed.
+
+### Distributing your theme
+
+If you want to distribute your theme so others can use it, you need to put it on a public git server, like GitHub. Then people can install it using _Install > Style > Theme_ in the Omarchy menu using that URL. It's recommended that you follow the naming convention of `omarchy-[themename]-theme`, as the theme will show correctly as just `[themename]` in the theme selection menu after installation.
+
+You can have your theme added to the extra themes list by pinging @tahayvr on [the #omarchy Discord](https://discord.gg/tXFUdasqhY).