---

Modular is a Neovim setup powered by 💤 lazy.nvim to make it easy to customize and extend your config.

⚡️ Requirements

• Neovim >= 0.9.0 (needs to be built with LuaJIT)
• Git >= 2.19.0 (for partial clones support)
• a Nerd Font(v3.0 or greater) (optional, but needed to display some icons)
• a C compiler for nvim-treesitter. See here
• for fzf-lua (optional)
  • fzf: fzf (v0.25.1 or greater)
  • live grep: ripgrep
  • find files: fd
• a terminal that support true color and undercurl:
  • alacritty (Linux, Macos & Windows)
  • kitty (Linux & Macos)
  • wezterm (Linux, Macos & Windows)
  • iterm2 (Macos)

Installation

Install Neovim

Modular targets only the latest 'stable' and latest 'nightly' of Neovim. If you are experiencing issues, please make sure you have the latest versions.

Install External Dependencies

External Requirements:

• Basic utils: git, make, unzip, C Compiler (gcc)
• ripgrep
• Clipboard tool (xclip/xsel/win32yank or other depending on platform)
• A Nerd Font: optional, provides various icons
  • if you have it set vim.g.have_nerd_font in init.lua to true
• Language Setup:
  • If you want to write Typescript, you need npm
  • If you want to write Golang, you will need go
  • etc.

Install Modular

NOTE Backup your previous configuration (if any exists)

mv ~/.config/nvim ~/.config/nvim.bak
mv ~/.local/share/nvim ~/.local/share/nvim.bak
mv ~/.local/state/nvim ~/.local/state/nvim.bak
mv ~/.cache/nvim ~/.cache/nvim.bak

Neovim's configurations are located under the following paths, depending on your OS:

OS	PATH
Linux, MacOS	$XDG_CONFIG_HOME/nvim, ~/.config/nvim
Windows (cmd)	%localappdata%\nvim\
Windows (powershell)	$env:LOCALAPPDATA\nvim\

Clone Modular

Linux and Mac

git clone https://github.com/masajinobe-ef/modular.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim

Windows

If you're using cmd.exe:

git clone https://github.com/masajinobe-ef/modular.nvim.git "%localappdata%\nvim"

If you're using powershell.exe

git clone https://github.com/masajinobe-ef/modular.nvim.git "${env:LOCALAPPDATA}\nvim"

Post Installation

Start Neovim

nvim

That's it! Lazy will install all the plugins you have. Use :Lazy to view current plugin status. Hit q to close the window.

Fedora Install Steps

sudo dnf install -y gcc make git ripgrep fd-find unzip neovim

Arch Install Steps

sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim

License

Based on Kickstart.nvim. This project is licensed under MIT. Please refer to the LICENSE file for detailed license information.