Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blacksuan19/init.nvim
An Opinionated Neovim Config for the Minimalists
https://github.com/blacksuan19/init.nvim
asynchronous coc fzf ide-features keyboard-shortcuts liquid neovim nvim nvim-settings prettier vim-script vimrc
Last synced: about 1 month ago
JSON representation
An Opinionated Neovim Config for the Minimalists
- Host: GitHub
- URL: https://github.com/blacksuan19/init.nvim
- Owner: Blacksuan19
- Created: 2019-11-29T09:26:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-18T16:21:00.000Z (4 months ago)
- Last Synced: 2024-10-13T06:40:22.957Z (about 1 month ago)
- Topics: asynchronous, coc, fzf, ide-features, keyboard-shortcuts, liquid, neovim, nvim, nvim-settings, prettier, vim-script, vimrc
- Language: Vim Script
- Homepage: https://www.blacksuan19.dev/projects/init-nvim/
- Size: 1.28 MB
- Stars: 422
- Watchers: 15
- Forks: 53
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Why?
Modern Vim distributions are really huge and bloated with way too many fancy
features that you won't ever use or need, for example directory trees like Nerd
tree, you don't need a tree, you can view a project structure with fzf which is
faster and has search. Another example is
[ThinkVim](https://github.com/hardcoreplayers/ThinkVim) has a separate extension
for formatting while also having ALE which can do that as well, this double
functionality is very common, thats one of the things this distro avoids, KISS!
## Features
- Single file (you don't want your dotfiles to be all Vim script)
- Super minimal (~400 lines)
- Super fast startup (less than 40ms!)
- Lazy loading plugins
- Highly customizable
- Beautiful [Material ocean](https://github.com/material-ocean/Material-Ocean)
color scheme
- Various IDE features via [coc.nvim](https://github.com/neoclide/coc.nvim)
- Smooth Scrolling (its really smooth!)
- Fully integrated with fzf (see [demos](#demos))
- Live Markdown preview
- Simple, Intuitive shortcuts
### Supported Languages
Neovim provides support for a wide range of languages by default. For more
languages install [vim-polyglot](https://github.com/sheerun/vim-polyglot).
## Requirements
- Linux (not tested on other platforms)
- Neovim (you can try regular Vim)
- Properly set up environment
## Setup
To check if your current environment is correctly set up run `:CheckHealth`.
### Environment
- python3: `pip3 install --user pynvim`
- javascript: `yarn global add neovim`
### Tools
- [Any patched nerd font](https://github.com/ryanoasis/nerd-fonts/)
- [tmux](https://github.com/tmux/tmux) (not required but recommended)
- [prettier](https://prettier.io/)
- clang (much better C and C++)
- [fuzzy finder (fzf)](https://github.com/junegunn/fzf)
- [ripgrep](https://github.com/BurntSushi/ripgrep)
- [bat](https://github.com/sharkdp/bat)
- [black](https://black.readthedocs.io/en/latest/) for python formatting
## Installation
After installing the requirements:
- `git clone https://github.com/Blacksuan19/init.nvim ~/.config/nvim`
- Start `nvim` and it will do the rest
- press enter if there are any errors (don't worry its fine)
## Plugins
Thanks to vim-plug the plugins are lazy loaded (anything that is not needed for
the current buffer is not loaded) for example opening a python file means all
other non python related plugins are not loaded. Coc extensions are lazy loaded
as well, they work the same way as vim-plug plugins.
| Plugin | Functionality |
| ------------------------------------------------------------------- | -------------------------------------------- |
| [vim-airline](https://github.com/vim-airline/vim-airline) | airline status line |
| [devicons](https://github.com/ryanoasis/vim-devicons) | icons everywhere |
| [rainbow](https://github.com/luochen1990/rainbow) | rainbow parenthesis |
| [vim-material](https://github.com/hzchirs/vim-material) | material themes |
| [coc.nvim](https://github.com/neoclide/coc.nvim) | async completion and more |
| [fzf.vim](https://github.com/junegunn/fzf.vim) | fuzzy finder vim integration |
| [vim-snippets](https://github.com/honza/vim-snippets) | snippets for many languages |
| [indentLine](https://github.com/Yggdroot/indentLine) | auto indent lines |
| [vim-commentary](https://github.com/tpope/vim-commentary) | better comments everywhere |
| [vim-startify](https://github.com/mhinz/vim-startify) | cool startup thingy |
| [vim-fugitive](https://github.com/tpope/vim-fugitive) | best git integration around |
| [vim-sandwich](https://github.com/machakann/vim-sandwich) | surround stuff with stuff |
| [vim-smoothie](https://github.com/psliwka/vim-smoothie) | super smooth scrolling |
| [tmux-navigator](https://github.com/christoomey/vim-tmux-navigator) | seamless movement between Vim and tmux panes |
| [tmux-complete](https://github.com/wellle/tmux-complete.vim) | tmux panes completion |
| [vim-eunuch](https://github.com/tpope/vim-eunuch) | some common Linux commands |
| [semshi](https://github.com/numirias/semshi) | better highlighting for python |
| [markdown-preview](https://github.com/iamcco/markdown-preview.nvim) | live markdown preview |
| [vim-MvVis](https://github.com/Jorengarenar/vim-MvVis) | move visual selection |
## Keyboard shortcuts
To learn the default Vim shortcuts run `Tutor` and or checkout this
[vim adventures](https://vim-adventures.com/).
#### Essentials
| Mapping | functionality |
| ------------ | ------------------------------------ |
| `;` | commands key |
| `,` | leader key |
| `leader + r` | reload nvim config |
| `leader + w` | save changes |
| `leader + e` | call :PlugInstall (install plug-ins) |
| `Enter` | enter empty line in normal mode |
| `F2` | trim white spaces |
| `F6` | open Startify |
#### Visual Mode Essentials
| Mapping | functionality |
| ---------- | ------------------------------- |
| `ctrl + j` | move selected text to bottom |
| `ctrl + k` | move selected text to top |
| `ctrl + h` | move selected text to the left |
| `ctrl + l` | move selected text to the right |
#### Navigation
`ctrl + hjkl` navigation also supports tmux panes.
| Mapping | functionality |
| ------------ | -------------------------------------- |
| `leader + q` | close tab |
| `ctrl + q` | close all buffers and exit |
| `ctrl + l` | move to the split on the right |
| `ctrl + k` | move the split above |
| `ctrl + j` | move to the split on below |
| `ctrl + h` | move the split to the left |
| `Tab` | switch to the next buffer(normal mode) |
| `S-Tab` | switch to the previous buffer |
#### IDE Features
| Mapping | functionality |
| ------------- | ------------------------------------ |
| `leader + o` | organize imports |
| `leader + a` | run cocAction on what's undercursor |
| `leader + s` | format file with available formatter |
| `leader + rn` | rename globally |
| `leader + jd` | jump to definition |
| `leader + jy` | jump to type definition |
| `leader + ji` | jump to implementation |
| `leader + jr` | jump to references |
| `ctrl + a` | highlight for multi cursor selection |
| `shift + k` | show current symbol documentation |
| `]g` | next diagnostic |
| `[g` | Previous diagnostic |
#### Flutter
| Mapping | functionality |
| ------- | -------------------------------------- |
| `F3` | show list of devices |
| `F4` | show list of emulators |
| `F5` | start development server (flutter run) |
#### FZF windows
| Mapping | functionality |
| ------------- | ---------------------------------------- |
| `leader + f` | files viewer |
| `leader + c` | show editor commands |
| `leader + /` | search in current folder files |
| `leader + sh` | search / history |
| `leader + b` | show open buffers |
| `leader + t` | search current file tags |
| `F1` | show keyboard shortcuts for current mode |
#### In FZF
these only work on an open fzf window
| Mapping | Functionality |
| ------- | ----------------------------- |
| `C-x` | open file in horizontal split |
| `C-v` | open file in vertical split |
| `C-t` | open file in new tab |
#### Git
| Mapping | functionality |
| ------------- | ------------------------ |
| `leader + gd` | git diff split |
| `leader + gc` | git commits |
| `leader + gb` | git blame |
| `leader + gs` | git status in fzf window |
## Custom commands
| Command | Functionality |
| ------- | ---------------------------------------- |
| Format | format file with any available formatter |
| OR | organize imports |
| Rg | advanced Grep |
## Customizations
Since the file is pretty small its very easy to interpret by even those who
don't have any knowledge about vim script, most of the sections have comments
about their functionality, and can be removed, commented out or swapped easily,
there are some defaults that are not everyone's cup of tea (after all this is
highly opinionated).
- **Disabling Plugins:** comment out the plug's 'Plugin/name' line from config
and also remove the plugin settings
- **Disabling CoC Plugins:** comment out the plugin from `coc_global_extensions`
variable and uninstall it via `:CocUninstall` plugin name
- **Installing CoC plugins:** open `:CocList` and search for marketplace, you
can find all available plugins here
- **Adding Bookmarks:** to add bookmarks to the start page, find
`g:startify_bookmarks` in `init.nvim` and add the new bookmark just like the
already present ones, the dictionary key is the shortcut you will use to
quickly jump to that folder from the start page and the value is the path to
targeted folder
for more customizations read throw the config file, there are comments
everywhere and its easy to interpret, you can also checkout the linked github
page for each plugin for even more options.
## Demos
### Project files with fzf
### Project wide search with fzf
### Git Status
### workflow demo
[](https://www.youtube.com/watch?v=_R2K0MrGLLI)
## Credits
All the Credit goes to the Neovim team for making most of the extensions
possible and better (async), and to all the plugins developers, and the hackers
who spend time Finding good shortcuts and tricks to make this an even more
superb experience.