Skip to content

ueaner/nvimrc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nvim configuration

nvim-preview

πŸš€ Getting Started

  • Make a backup of your current Neovim files:
mv ~/.config/nvim ~/.config/nvim.bak
mv ~/.local/share/nvim ~/.local/share/nvim.bak
  • Clone nvimrc
git clone https://github.com/ueaner/nvimrc ~/.config/nvim
  • Remove the .git folder, so you can add it to your own repo later
rm -rf ~/.config/nvim/.git
  • Start Neovim!
nvim

⚑️ Requirements

  • Neovim nightly or latest version. See here and here
  • a Nerd Font (optional). See here
  • a C compiler for nvim-treesitter. See here

⌨️ Keymaps

See keymaps.md.

✨ Features

Supported Programming Languages:

πŸ“ File Structure

lua
β”œβ”€β”€ config
β”‚   β”œβ”€β”€ init.lua         -- configure of icons, close_with_q list, etc.
β”‚   β”œβ”€β”€ lazy.lua         -- configure lazy.nvim
β”‚   β”œβ”€β”€ autocmds.lua
β”‚   β”œβ”€β”€ keymaps.lua
β”‚   └── options.lua
β”œβ”€β”€ plugins
β”‚   β”œβ”€β”€ ui.lua           -- UI Appearance
β”‚   β”œβ”€β”€ editor.lua       -- Editor Features
β”‚   β”œβ”€β”€ coding.lua       -- Coding Features
β”‚   β”œβ”€β”€ lsp.lua
β”‚   β”œβ”€β”€ dap.lua
β”‚   β”œβ”€β”€ test.lua
β”‚   β”œβ”€β”€ treesitter.lua
β”‚   └── extras
β”‚       β”œβ”€β”€ tools
β”‚       β”‚   β”œβ”€β”€ database.lua
β”‚       β”‚   β”œβ”€β”€ plantuml.lua
β”‚       β”‚   β”œβ”€β”€ rest.lua
β”‚       β”‚   └── ...
β”‚       └── lang         -- language specific extension modules
β”‚           β”œβ”€β”€ yaml.lua
β”‚           β”œβ”€β”€ python.lua
β”‚           β”œβ”€β”€ go.lua
β”‚           β”œβ”€β”€ ...
β”‚           +-- spec.lua
└── util.lua

Contents of ui, editor and coding:

  • UI Appearance: statusline, tabline, winbar, scrollbar, indent, icons, notify, messages, cmdline, popupmenu, etc.
  • Editor Features: which-key, fuzzy finder, file explorer, outline, jump, git signs, todo comments, auto-resize windows, etc.
  • Coding Features: auto completion, snippets, comments, refactoring, auto pairs, etc.