Avex Neovim

Avex Neovim is a lightweight and high performance configuration built from scratch. It is designed for developers who want a clean, distraction-free environment while maintaining powerful features.

Key-features

1. Avex dashboard
   A custom screen using alpha-nvim with a "Avex" ASCII logo with shortcuts.
2. Nightfly colorscheme
   Cool theme for professional use, optimized for long coding sessions.
3. Custom statusline
   Modern, informative bottom bar with added shortcut to display diagnostics.
4. Your favourite shortcuts
   Available visual shortcut hints made neovim easier.
5. Integrated terminal
   Built for fast, and efficient terminal accessible with a single keystroke. Perfect for managing scripts, and viewing outputs.

Requirements

1. Nerd Font
   A nerd font is required to install so that it renders the custom icons in the dashboard, file explorer, and status line. Without it, icons will appear as broken boxes or question marks. Recommended: JetBrainsMono Nerd Font

2. Terminal emulator
   This neovim config is optimized for ghostty fast rendering and native image support. It is GPU-accelerated and smooth UI performance.

NOTE: Mason is used to install and manage LSP servers, DAP servers, linters, and formatters via the :Mason command.

Installation Method 1

1. Clone the repository
   Clone avex-nvim into your standard Neovim config directory:

git clone https://github.com/avexcz/avex-nvim.git ~/.config/nvim
cd ~/.config/nvim

2. Install Plugins
   Open Neovim (nvim). You may see some initial errors and this is normal as plugins aren't installed yet. Run the following command:

:PackerSync

Note: You may need to restart Neovim after the sync finishes for all UI elements to load correctly. If packer fails, then install Packer manager so that neovim notice the plugin-setup:
git clone --depth 1 https://github.com/wbthomason/packer.nvim \ ~/.local/share/nvim/site/pack/packer/start/packer.nvim

Get Healthy

open neovim via nvim on terminal and enter the following:

:checkhealth

It is normal to have warnings. I'll update them, don't worry about and stay in touch!

Installation Method 2 (Shortcut)

1. Install Docker
   Install docker via docker.com and sign-up.

2. Run Avex
   Once Docker is running, you need to login via docker login on your CLI and you don't need to clone this repo or install plugins manually. Simply run the following command in your terminal:

docker run -it --rm devXam5/avex-nvim

3. Copy configuration to local machine (Recommended)

docker run --rm -v ~/.config/nvim:/install_destination devxam5/avex-nvim \
sh -c "cp -rv /root/.config/nvim/. /install_destination"

4. Run and update neovim
   nvim :PackerSync

🛑 WARNING: Running the install command will overwrite your existing Neovim configuration. If you have an existing config, back it up first: bash mv ~/.config/nvim ~/.config/nvim_backup

Note: Alpine linux's neovim is capped to 0.11.7 version which can cause tree-sitter an error after running :checkhealth. It is best to copy this configuration to your local machine with your latest neovim (0.12.0)

Install Neovim

MacOS:

```bash
brew upgrade neovim
```

Windows:

```bash
winget upgrade Neovim.Neovim
```

Linux:

Ubuntu/Debian: bash sudo apt update sudo apt upgrade neovim

Arch: bash sudo pacman -Syu neovim

Fedora: sudo dnf upgrade neovim

If it fails, try manual installation from official neovim

Recommended Version

Neovim >= 0.11 is recommended for modern configurations.