Files
apex/INSTALL.md
2025-12-30 07:02:42 +01:00

2.8 KiB

Apex Theme System: Installation Guide

This guide explains how to install the Apex Neon (Dark) and Apex Aeon (Light) themes for various applications. All generated theme files can be found in the dist/ directory after running the build script.


1. Neovim (nvim)

Files:

  • dist/nvim/colors/apex-neon.lua
  • dist/nvim/colors/apex-aeon.lua

Manual Installation:

  1. Copy the files to your Neovim colors directory:
    mkdir -p ~/.config/nvim/colors
    cp dist/nvim/colors/*.lua ~/.config/nvim/colors/
    
  2. Enable the theme in your init.lua:
    vim.cmd.colorscheme "apex-neon"
    -- or
    vim.cmd.colorscheme "apex-aeon"
    

2. Zsh

Files:

  • dist/zsh/apex-neon.zsh-theme
  • dist/zsh/apex-aeon.zsh-theme

Installation:

  1. Source the desired theme file in your .zshrc.

  2. Ideally, place the file in a standard location like ~/.zsh/themes/.

    # In ~/.zshrc
    source /path/to/apex-neon.zsh-theme
    

3. Kitty Terminal

Files:

  • dist/kitty/apex-neon.conf
  • dist/kitty/apex-aeon.conf

Installation:

  1. Copy the files to your Kitty config directory:
    cp dist/kitty/*.conf ~/.config/kitty/
    
  2. Include one of them in your ~/.config/kitty/kitty.conf:
    include apex-neon.conf
    # include apex-aeon.conf
    

4. Alacritty

Files:

  • dist/alacritty/apex-neon.toml
  • dist/alacritty/apex-aeon.toml

Installation:

  1. Copy the files to your Alacritty config directory:
    mkdir -p ~/.config/alacritty/themes
    cp dist/alacritty/*.toml ~/.config/alacritty/themes/
    
  2. Import the theme in your ~/.config/alacritty/alacritty.toml:
    [general]
    import = ["~/.config/alacritty/themes/apex-neon.toml"]
    

5. Zed Editor (Local Dev)

Files:

  • dist/zed/apex.json (Contains both Neon and Aeon variants)

Installation: Zed loads local extensions from the extensions folder, but for simple theme development, you can open the theme file directly in Zed or follow Zed's extension development guide.

For local usage:

  1. Ensure the apex.json is formatted as a proper extension if you plan to publish it.
  2. Currently, this file is a raw theme definition. You may need to wrap it in a Zed extension structure to load it permanently via the extensions menu.

6. Gemini CLI

Files:

  • dist/gemini/apex-neon.json
  • dist/gemini/apex-aeon.json

Installation:

  1. Edit your Gemini settings file (usually ~/.config/gemini/settings.json or via gemini settings).

  2. Point the theme property to the absolute path of the generated file:

    {
      "ui": {
        "theme": "/absolute/path/to/dist/gemini/apex-neon.json"
      }
    }