Documentation | Neovim_Chad

Home • Install • Contribute • Support • Features

ShowCase

What is it?

• NvChad is a neovim config written in lua aiming to provide a base configuration with very beautiful UI and blazing fast startuptime (around 0.02 secs ~ 0.07 secs). We tweak UI plugins such as telescope, nvim-tree etc well to provide an aesthetic UI experience.

• Lazy loading is done 93% of the time meaning that plugins will not be loaded by default, they will be loaded only when required also at specific commands, events etc. This lowers the startuptime and it was like 0.07~ secs tested on an old pentium machine 1.4ghz + 4gb ram & HDD.

• NvChad is supposed to be used with its starter config, so nvchad main repo ( this repo ) can be imported as a plugin via lazy's import feature and then you can easily use this repo's modules like autocmds etc.

Theme Showcase

UI related plugins used

Nvim-tree.lua

Fast file tree:

Telescope-nvim

A fuzzy file finder, picker, sorter, previewer and much more:

Our own statusline written from scratch

NvChad UI

Tabufline (our own pertab bufferline)

• Here's a video that showcases it.

NvCheatsheet ( our UI Plugin )

Modern Theme Picker

For detailed info list, check features page

Project layout

├─ cmake/           CMake utils
├─ cmake.config/    CMake defines
├─ cmake.deps/      subproject to fetch and build dependencies (optional)
├─ runtime/         plugins and docs
├─ src/nvim/        application source code (see src/nvim/README.md)
│  ├─ api/          API subsystem
│  ├─ eval/         Vimscript subsystem
│  ├─ event/        event-loop subsystem
│  ├─ generators/   code generation (pre-compilation)
│  ├─ lib/          generic data structures
│  ├─ lua/          Lua subsystem
│  ├─ msgpack_rpc/  RPC subsystem
│  ├─ os/           low-level platform code
│  └─ tui/          built-in UI
└─ test/            tests (see test/README.md)

# Neovim Chad Setup 🚀

Welcome to the Neovim Chad Setup! This repository contains a fast and optimized Neovim configuration with a focus on development workflows. It includes custom settings, plugins, and key mappings to enhance your productivity.

Features ✨

• Pre-configured Neovim setup with powerful plugins
• Optimized for coding (LSP, Git, and UI enhancements)
• Cross-platform support (Windows, macOS, Linux, and Arch)
• Easy-to-use configuration for developers
• Modular and customizable

Installation 🛠️

Requirements 📦

• Neovim (v0.5 or later)
• Git for version control
• Node.js for LSP and plugin support
• Python for some plugins (e.g., pynvim for Python support)

---

1. Linux Installation 🐧

Step 1: Install Dependencies

For Ubuntu-based systems, run the following:

sudo apt update
sudo apt install -y neovim git curl python3-pip python3-venv nodejs npm
git clone --depth 1 https://github.com/wbthomason/packer.nvim ~/.local/share/nvim/site/pack/packer/start/packer.nvim
git clone https://github.com/ExploitEngineer/Neovim_Chad.git ~/.config/nvim
nvim
:PackerSync

2. macOS Installation 🍏 Step 1: Install Dependencies Install Homebrew if you don't have it installed already. Then, run:

brew install neovim git curl python3 node npm
git clone --depth 1 https://github.com/wbthomason/packer.nvim ~/.local/share/nvim/site/pack/packer/start/packer.nvim
git clone https://github.com/ExploitEngineer/Neovim_Chad.git ~/.config/nvim
nvim
:PackerSync

3. Windows (WSL) Installation 💻 Step 1: Install Dependencies For Windows using WSL, run the following commands:

sudo apt update
sudo apt install -y neovim git curl python3-pip python3-venv nodejs npm
git clone --depth 1 https://github.com/wbthomason/packer.nvim ~/.local/share/nvim/site/pack/packer/start/packer.nvim
git clone https://github.com/ExploitEngineer/Neovim_Chad.git ~/.config/nvim
nvim
:PackerSync

4. Arch Linux Installation 🖥️ Step 1: Install Dependencies Run the following:

sudo pacman -Syu
sudo pacman -S neovim git curl python-pip nodejs npm
git clone --depth 1 https://github.com/wbthomason/packer.nvim ~/.local/share/nvim/site/pack/packer/start/packer.nvim
git clone https://github.com/ExploitEngineer/Neovim_Chad.git ~/.config/nvim
nvim
:PackerSync

Usage 🖋️ Once the setup is complete, you can start using Neovim Chad by opening Neovim and working with all the pre-configured settings and plugins.

To open Neovim, simply type:

Copy

Enjoy coding with Neovim Chad!

Support & Issues 🛠️ If you face any issues or have any questions, feel free to open an issue on this repository.

Happy coding! 🚀