• Introduction
  • What is it?
  • What does it include?
  • Why is it good?
  • Why call it SolarVim?
• Installation
  • Dependencies
  • Backing up old configs
  • SolarVim
  • Packages
  • Syntax Highlighters
  • LSPs
• Star Goal

SolarVim is a custom configuration based on the kickstart-modular.nvim framework. It uses a transparent Catppuccin Mocha colorscheme that's perfect for development at any time of the day.

It includes:

• Neotree
• Lualine
• Snacks
• Telescope
• Treesitter
• Which-key
• Conform
• Autopairs

These are used to provide a lightweight, fully functional development environment that's ready out of the box.

After testing and configuring every major Neovim distribution (NvChad, AstroNvim, LunarVim, LazyVim), I decided what I liked and added it to SolarVim. This allowed me to take the best parts of each distribution and no more.

So, here's what I took:

• AstroNvim's neo-tree shortcuts
• LazyVim's start menu
• NvChad's comment toggling
• LunarVim's intuitiveness
• Telescope
• Lualine
• Which-key

The name SolarVim is a small nod to LunarVim which I believe is a great startpoint for those who want to ease into Neovim which allows you to worry less about configuration and more about how the editor works (and how you escape).

SolarVim is pretty much a next step. Most of the configuration is done for you with simple commands for install syntax highlighters ans LSPs. A lot of this is thanks to kickstart-modular.nvim which does a lot of the hard work setting up Lazy and Mason.

Basic tools:

• git
• make
• unzip
• C Compiler (gcc)
• ripgrep
• Clipboard tool (xclip/xsel/win32yank or other depending on platform)

Looks:

• Any Nerd Font

Language Setup:

• The compiler/interpreter for the language

If you have Neovim installed already then it's worth backing up your config to make sure you can go back to it if you want. This can be done using mv on each of the folders your config uses:

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

Clone the SolarVim repo to your Neovim config directory and then start Neovim:

git clone https://github.com/DoubleDotStudios/SolarVim.git ~/.config/nvim
nvim

Once Neovim is opened after installing SolarVim, Lazy should open and install some packages. If it doesn't then type :Lazy sync and the packages will be installed.

After that's finished, type :MasonInstallAll and that will install the rest of the packages that SolarVim uses.

To install a syntax highlighter simply type :TSInstall language_name and the highlighter will be installed.

To install an LSP simply type :LspInstall language_name and a popup will be displayed asking which LSP you would like to install for that language. Select the one you want and it'll be installed.

If this repo hits 50 stars then I'll make SolarVim a proper Neovim distribution.

Progress ( = 5 stars): [⭘ ⭘ ⭘ ⭘ ⭘ ⭘ ⭘ ⭘ ⭘ ⭘]