Skip to content

Luavim is a simple neovim configuration written in lua, aiming to provide a base config.

License

Notifications You must be signed in to change notification settings

elairavi/luavim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

luavim tree+split

Description

  • Luavim is a simple neovim configuration written in lua, aiming to provide a base config, so users could tweak the defaults, remove the things they don't like, and build their config on top of it.

Table of Contents

Plugins List

  • packer.nvim - A use-package inspired plugin manager for Neovim
  • nvim-treesitter - Nvim Treesitter configurations and abstraction layer
  • nvim-tree.lua - A file explorer tree for neovim written in lua
  • lualine.nvim - A blazing fast and easy to configure neovim statusline plugin written in pure lua
  • nvim-web-devicons - A Lua fork of vim-devicons
  • nvim-comment - A comment toggler for Neovim, written in Lua
  • gitsigns.nvim - Git integration for buffers
  • nvim-colorizer.lua - The fastest Neovim colorizer
  • nord.nvim - Neovim theme based off of the Nord Color Palette, written in lua with tree sitter support
  • alpha-nvim - a lua powered greeter like vim-startify / dashboard-nvim
  • nvim-cmp - A completion plugin for neovim coded in Lua
  • cmp-buffer - nvim-cmp source for buffer words
  • cmp-path - nvim-cmp source for path
  • LuaSnip - Snippet Engine for Neovim written in Lua
  • impatient.nvim - Improve startup time for Neovim
  • neoscroll.nvim - Smooth scrolling neovim plugin written in lua
  • toggleterm.nvim - A neovim lua plugin to help easily manage multiple terminal windows
  • telescope.nvim - Find, filter, preview, pick. all lua, with telescope
  • plenary.nvim - All the lua functions I don't want to write twice

Directory Tree

├── ftplugin
│   └── lua.lua
├── init.lua
└── lua
    ├── configs
    │   ├── alpha.lua
    │   ├── colorizer.lua
    │   ├── colorschemes.lua
    │   ├── commentary.lua
    │   ├── completion.lua
    │   ├── gitsigns.lua
    │   ├── impatient.lua
    │   ├── neoscroll.lua
    │   ├── nvimtree.lua
    │   ├── statusline.lua
    │   ├── telescope.lua
    │   ├── toggleterm.lua
    │   └── treesitter.lua
    ├── core
    │   ├── keymaps.lua
    │   ├── options.lua
    │   └── plugins.lua
    └── utils
        └── utils.lua

Installation

  • Install Neovim v0.7.x
  • Install a nerd font (for the font in the screenshot, install JetBrainsMono)
  • Follow this guide if you don't know how to install patched nerd-fonts
  • Make sure you backup your current nvim directory
mv ~/.config/nvim ~/.config/nvim_backup
mv ~/.local/share/nvim ~/.local/share/nvim_backup
  • Download luavim with git and place it into ~/.config/nvim
git clone https://github.com/elairavi/luavim.git ~/.config/nvim
  • Run nvim and wait for the plugins to be installed, when all the plugins are installed close neovim and reopen it
  • You will notice treesitter pulling in a bunch of parsers the second time you open Neovim
  • Note: checkout this file for some predefined key-mappings

Configuration check

  • Open neovim with this flag nvim +checkhealth you should not see any errors in the output (except for the one related to Python):

checkhealth

  • Note: If you're having a problem or some kinda of an error with a plugin, just run these commands:
rm -rf ~/.cache/nvim
rm -rf ~/.config/nvim/plugin
rm -rf ~/.local/share/nvim
nvim
  • If the problem persists open an issue and i will do what i can to help.

Uninstalation

  • Note: I suggeste you backup your config first, consider mv ~/.config/nvim ~/.config/nvim_backup and then run these commands to uninstall luavim
rm -rf ~/.config/nvim
rm -rf ~/.local/share/nvim
rm -rf ~/.cache/nvim

Resources

Neovim lua projects and examples

Guides and resources

Lua resources

Special Thanks

  • Thanks to all the authors of the sources mentioned above, And special thanks to ChristianChiarulli and brainfucksec For making this configuration possible.

Lua