https://github.com/taohexxx/navim
A full-blown IDE based on Neovim (or Vim) with better navigation.
https://github.com/taohexxx/navim
airline lightline neovim spacemacs unite vim vimrc
Last synced: about 1 year ago
JSON representation
A full-blown IDE based on Neovim (or Vim) with better navigation.
- Host: GitHub
- URL: https://github.com/taohexxx/navim
- Owner: taohexxx
- License: mit
- Created: 2018-03-13T03:01:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-09-19T06:47:30.000Z (almost 7 years ago)
- Last Synced: 2025-03-31T00:41:15.750Z (over 1 year ago)
- Topics: airline, lightline, neovim, spacemacs, unite, vim, vimrc
- Language: Vim script
- Homepage:
- Size: 9.04 MB
- Stars: 16
- Watchers: 0
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Navim · [](https://travis-ci.org/taohexxx/navim) [](http://makeapullrequest.com)
A full-blown IDE based on Neovim (or Vim) with better navigation.
**Table of Contents**
- [Key Mapping](#key-mapping)
- [Basic Installation](#basic-installation)
- [Advanced Settings](#advanced-settings)
- [Advanced Installation](#advanced-installation)
- [Plugins](#plugins)
- [Coding Style](#coding-style)
- [Tags](#tags)
- [Credits](#credits)
- [License](#license)
## Key Mapping
You don't need to remember any key mapping, as navigation bar will show up immediately after the leader key (Space by default) is pressed.
Default `` is Space, `` is ,. For example, Space s s search the word under cursor. As shown below, key mapping is carefully-chosen.
Most of key mapping is [denite](https://github.com/Shougo/denite.nvim) centric. More key mapping is listed here:
Key Mapping | Description
--------------------------------------------------------------|------------------------------------------------------------
Left and Right | previous buffer, next buffer
Ctrl+h and Ctrl+l | move to window in the direction of hl
Ctrl+j and Ctrl+k | move to window in the direction of jk
Ctrl+w o | maximize or restore current window in split structure
Q | close windows and delete the buffer (if it is the last buffer window)
## Basic Installation
Basic installation is simple:
```sh
pip3 install --upgrade pip neovim
git clone --recursive https://github.com/taohexxx/navim ~/.config/nvim
```
Make links if you are using Vim:
```sh
mv ~/.vim ~/.vim.backup
mv ~/.vimrc ~/.vimrc.backup
ln -s ~/.config/nvim ~/.vim
ln -s ~/.config/nvim/init.vim ~/.vimrc
```
Startup vim and [dein](https://github.com/Shougo/dein.vim) will detect and ask you install any missing plugins.
## Advanced Settings
Plugins are nicely organised in layers. There are many ready-to-use layers (javascript, navigation, scm, web, etc.) and you can add your own ones.
Private layers can be added to `private_layers/`. And Private plugins can be added to `private_bundle/`. The content of these two directory is ignored by Git.
It is completely customisable using a `~/.navimrc` file. Just copy `.navimrc.sample` to `~/.navimrc` and modify anything.
After restart Neovim (or Vim), run `call dein#clear_state() || call dein#update()` to apply changes.
### Global Variables
In most instances, modify `g:navim_settings` in `~/.navimrc` should meet your needs.
Key | Value | Description
-------------------------|-----------------------------------------------------|-------------------------------------------
`layers` | `'c'`, `'completion'`, `'editing'`, ... | files in `layers/` or `private_layers/`
`additional_plugins` | `'joshdick/onedark.vim'`, ... | github repo
`encoding` | `'utf-8'`, `'gbk'`, `'latin1'`, ... | files in `encoding/`
`bin_dir` | `'/usr/local/bin'`, ... | bin directory for cscope, ctags, gdb, ...
`clang_dir` | `'/usr/local'`, ... | install directory for clang
`cscopeprg` | `'gtags-cscope'`, `'cscope'`, ... | cscope program
`explorer_plugin` | `'defx'`, `'nerdtree'` |
`statusline_plugin` | `'airline'`, `'lightline'` |
`completion_plugin` | `'deoplete'`, `'coc'`, `'ycm'` |
`syntaxcheck_plugin` | `'ale'`, `'syntastic'` |
`colorscheme` | `'solarized'`, `'molokai'`, `'jellybeans'` | use other colorschemes in `additional_plugins` or `layers` is supported
`powerline_fonts` | `1`, `0` | requires [fonts](https://github.com/taohexxx/fonts)
`nerd_fonts` | `1`, `0` | requires [fonts](https://github.com/taohexxx/fonts)
Use `:echo g:navim_setting` in Neovim (or Vim) to check for runtime settings.
## Advanced Installation
### macOS
YouComplete **only** support Neovim or MacVim.
#### Install Neovim (Recommended)
```sh
pip install --upgrade pip
pip3 install --upgrade pip
pip install --user --upgrade neovim
pip3 install --user --upgrade neovim
brew tap neovim/neovim
brew update
brew reinstall --HEAD neovim
```
Make alias
```sh
alias vi='nvim'
alias vim="nvim"
alias vimdiff="nvim -d"
```
If `` does not work in neovim, add these line to `~/.zshrc`
```sh
infocmp $TERM | sed 's/kbs=^[hH]/kbs=\\177/' > $TERM.ti
tic $TERM.ti
```
Execute the `:UpdateRemotePlugins` and restart Neovim.
#### Install MacVim
```sh
brew install macvim --with-luajit --override-system-vim
```
Make alias
```sh
alias vi="mvim -v"
alias vim="mvim -v"
alias vimdiff="mvim -d -v"
```
#### Install GLOBAL
```sh
brew install global
```
#### Select Auto Completion
Select auto completion plugins between [Deoplete](https://github.com/Shougo/deoplete.nvim), [Coc](https://github.com/neoclide/coc.nvim) and [YouCompleteMe](https://github.com/ycm-core/YouCompleteMe).
* [Deoplete](https://github.com/Shougo/deoplete.nvim): Zero configuration without [LSP](https://langserver.org/) support. If you don't write C++ or Java, use this.
* [Coc](https://github.com/neoclide/coc.nvim): Simple initialization with [LSP](https://langserver.org/) support. If you write C++ or Java, use this.
* [YouCompleteMe](https://github.com/ycm-core/YouCompleteMe): Complicated initialization with [LSP](https://langserver.org/) support. Not recommanded.
#### Auto Completion with [Deoplete](https://github.com/Shougo/deoplete.nvim)
Add this line to `~/.navimrc`:
```vim
let g:navim_settings.completion_plugin = 'deoplete'
```
#### Auto Completion with [Coc](https://github.com/neoclide/coc.nvim)
Add this line to `~/.navimrc`:
```vim
let g:navim_settings.completion_plugin = 'coc'
```
Install [Node.js](https://nodejs.org/en/download/).
```sh
brew install node
```
Write your `~/.config/nvim/coc-settings.json`. For example, using c++ with ccls:
```json
{
"languageserver": {
"ccls": {
"command": "ccls",
"args": ["--log-file=/tmp/ccls.log"],
"filetypes": ["c", "cpp", "cuda", "objc", "objcpp"],
"rootPatterns": [
".ccls",
"compile_commands.json",
".vim/",
".git/",
".hg/"
],
"initializationOptions": { "cache": { "directory": ".ccls-cache" } }
}
},
"suggest.triggerAfterInsertEnter": true,
"suggest.noselect": false,
"suggest.enablePreview": true,
"suggest.minTriggerInputLength": 2,
"suggest.acceptSuggestionOnCommitCharacter": true
}
```
You need to install coc extensions manually like this for the first time: `:CocInstall coc-snippets coc-highlight coc-lists`.
[Using coc extensions](https://github.com/neoclide/coc.nvim/wiki/Using-coc-extensions).
#### Auto Completion with [YouCompleteMe](https://github.com/ycm-core/YouCompleteMe) (Quick Compile)
Add this line to `~/.navimrc`:
```vim
let g:navim_settings.completion_plugin = 'ycm'
```
##### Compile ycm_core
```sh
cd ~/.config/nvim/bundle/repos/github.com/Valloric/YouCompleteMe/
./install.sh --all
# or
# ./install.sh --clang-completer --go-completer --js-completer
```
Check for `~/.config/nvim/bundle/repos/github.com/Valloric/YouCompleteMe/third_party/ycmd/libclang.dylib` and `~/.config/nvim/bundle/repos/github.com/Valloric/YouCompleteMe/third_party/ycmd/ycm_core.so`, done
##### TypeScript Support
```sh
yarn global add typescript
```
#### Auto Completion with [YouCompleteMe](https://github.com/ycm-core/YouCompleteMe) (Full Compile)
Try this if quick compile does not work.
Add this line to `~/.navimrc`:
```vim
let g:navim_settings.completion_plugin = 'ycm'
```
##### Clone
```sh
mkdir -p ~/.config/nvim/bundle/repos/github.com/Valloric/
cd ~/.config/nvim/bundle/repos/github.com/Valloric/
git clone https://github.com/Valloric/YouCompleteMe
cd YouCompleteMe/
git submodule update --init --recursive
```
##### Compile ycm_core
Download clang from to `~/local/src/` and compile ycm_core
```sh
mkdir -p ~/local/src/
cd ~/local/src/
tar xf clang+llvm-6.0.0-x86_64-apple-darwin.tar.xz
mkdir -p ~/local/src/ycm_build/
cd ~/local/src/ycm_build/
cmake -G "Unix Makefiles" -DPATH_TO_LLVM_ROOT=~/local/src/clang+llvm-6.0.0-x86_64-apple-darwin . ~/.config/nvim/bundle/repos/github.com/Valloric/YouCompleteMe/third_party/ycmd/cpp
cmake --build . --target ycm_core --config Release
```
Check for `~/.vim/bundle/YouCompleteMe/third_party/ycmd/libclang.dylib` and `~/.vim/bundle/YouCompleteMe/third_party/ycmd/ycm_core.so`, done
##### Compile regex (Optional)
```sh
cmake -G "Unix Makefiles" . ~/.config/nvim/bundle/repos/github.com/Valloric/YouCompleteMe/third_party/ycmd/third_party/cregex
cmake --build . --target _regex --config Release
```
Check for `~/.config/nvim/bundle/repos/github.com/Valloric/YouCompleteMe/third_party/ycmd/third_party/cregex/regex_3/_regex.so`, done
##### Go Support
```sh
cd ~/.config/nvim/bundle/repos/github.com/Valloric/YouCompleteMe/third_party/ycmd/third_party/gocode
go build
```
##### JavaScript Support
```sh
cd ~/.config/nvim/bundle/repos/github.com/Valloric/YouCompleteMe/third_party/ycmd/third_party/tern_runtime
yarn install --production
```
##### TypeScript Support
```sh
yarn global add typescript
```
#### Project Configuration
Download to your project directory
### Windows
```sh
git clone --recursive https://github.com/taohexxx/navim %userprofile%\AppData\Local\nvim
```
run `nvim.exe` before run `nvim-qt.exe`
## Plugins
* [denite.nvim](https://github.com/Shougo/denite.nvim)
* [unite.vim](https://github.com/Shougo/unite.vim)
* [lightline.vim](https://github.com/itchyny/lightline.vim)
* [lightline-buffer](https://github.com/taohexxx/lightline-buffer)
* [Coc](https://github.com/neoclide/coc.nvim)
* [deoplete](https://github.com/Shougo/deoplete.nvim)
* [Defx](https://github.com/Shougo/defx.nvim)
* [unimpaired](https://github.com/tpope/vim-unimpaired)
* [editorconfig](https://github.com/editorconfig/editorconfig-vim)
* ...
## Coding Style
[EditorConfig](http://editorconfig.org/) is supported.
Create an `.editorconfig` in any parent directory for consistent coding styles.
## Tags
`~/.config/nvim/tags/*.tags` will be auto added.
[Tags (`:h navim-tags`)](https://github.com/taohexxx/navim/blob/master/doc/navim.txt#L338)
## Help
[Help (`:h navim`)](https://github.com/taohexxx/navim/blob/master/doc/navim.txt)
## Credits
Built with :heart:. I wanted to give special thanks to all of the following projects and people, because I learned a lot and took many ideas and incorporated them into my configuration.
* [spacemacs](https://github.com/syl20bnr/spacemacs)
* [shougo](https://github.com/Shougo)
* ...