/nvim-config

A pretty epic NeoVim setup

Primary LanguageLuaGNU General Public License v3.0GPL-3.0

My personal modern NeoVim config

Autocomplete

Git diff


Doc preview

Glance


Floating terminal


Telescope search


Setup

  1. Use the latest version of NVIM
  2. Install packer.nvim

This setup uses packer.nvim as package manager, so first install packer.nvim by following the official instructions

  1. Clone this repo into ~/.config/nvim:
git clone  https://github.com/Stephan14/nvim-config.git ~/.config/nvim
  1. When you first enter nvim, you will see a bunch of mess because the plugins aren't installed yet, so run :PackerInstall to install the plugins

Note that there is a chance that the download would timeout and packer.nvim would report install failed, in this case run :PackerInstall again

  1. This setup uses the modern LSP system for language support, things like auto-complete, symbols tree, etc..., which requires a LSP server outside the editor. Fortunately nvim-lspconfig manages to configure most of the LSP server options for us, all we need to do is to install the LSP servers themselves:

In lua/configs/autocomplete.lua, line 108, edit the list of LSP servers, a complete list of supported LSP servers is listed here. After that install the corresponding servers on your OS, auto-complete should pop up for supported languages now :)

  1. Final step, smart highlighting using treesitter!

The default vim regex-based highlighting is pretty lame, for NVIM, treesitter offered an advanced code highlighting that can make your code much cleaner

You can use the :TSInstall <lang> command to install a parser for a language

Alternatively, in lua/configs/treesitter.lua, line 6, you can have a list of parsers that will be updated every time you use the :TSUpdate or :TSUpdateSync command (the latter is for synchronized updating), or you can just install all maintained parsers by uncommenting line 5 and commenting line 6

  1. AI completion (optional)

This config also uses ai.nvim plugin for AI completion, which requires you set an environmental variable called OPENAI_API_KEY. You can get an OpenAI API key here. After that, you can use <C-a> to activate AI completion, you can either add a comment telling the AI what to do, or send it a message using :AI <message>.

Usage

TODO: for now read lua/core/keymaps.lua for the keymaps

Note that the config uses ; as the leader key by default, you can change it in lua/core/keymaps.lua, line 1

Most keymaps in this setup are what I call declarative keymaps, for example, everything related to terminal emulator starts with ;t, so ;tt means "terminal toggle", and ;tn means "terminal new"

FAQ

Why does the theme not match the screenshots?

I switch between a few themes sometimes during my usage just to fresh things up a bit, the screenshots are quite old and might not reflect the latest theme, you can change the theme at lua/core/theme.lua. You can also switch between light and dark mode using the keymap <leader>vd (dark) and <leader>vl (light).

Why are there a bunch of question marks?

They are supposed to be the fancy file and arrow icons, to use these icons you need Nerd Fonts, a special kind of font that supports these icons.

Why does it have a bunch of error messages?

First check if you have followed the setup instructions.

If you have, it's probably because the config is for older versions of NeoVim or the plugins and I haven't updated it yet. Check the latest update date, if it's over a few months then it's likely that, if you know what exactly is broken with the update please open an issue.

Contributing

Having troubles

If you have issues while installing or using my this setup, report an issue, if the problem occurred during setup, first make sure you have followed through the setup guide. don't just DM me on social media because others may run into the same problem and they can use the existing issues as a reference

Discussions could be in either English or Chinese, although English is preferred

Adding more things

For now, you don't, this is my personal config. However if there's any problem with the documentation above feel free to correct or add more details by a PR.

快捷键

  • 插入模式下, ctrl+g 等价于esc
  • 正常模式下，\+v+l 等价于切换成白色背景
  • 正常模式下，\+v+d 等价于切换成黑色背景

lspsaga插件

  • 正常模式下，\+e+e 等价于对当前行进行诊断提示
  • 正常模式下，\+e+f 等价于对当前光标进行诊断提示
  • 正常模式下，\+e+l 等价于对当前打开的文件进行诊断提示
  • 正常模式下，\+l+q 等价于对当前窗口代码进行诊断提示
  • 正常模式下，\+l+k 等价于展示当前函数的参数介绍
  • 正常模式下，\+l+f 等价于展示当前函数的定义
  • 正常模式下，\+l+r 等价于重命名
  • 正常模式下，\+l+f 等价于格式化

展示状态栏

  • 正常模式下，\+w+8 等价于展示/隐藏左侧文件目录
  • 正常模式下，\+w+9 等价于展示/隐藏右侧git信息

搜索操作

  • 正常模式下，\+s+f 等价于根据文件名进行搜索
  • 正常模式下，\+s+f 等价于根据文件内容进行搜索需要安装（brew install ripgrep）
  • 正常模式下，F11 等价于展示在buffer中文件并进行搜索
  • 正常模式下，ctrl+p 等价于展示在buffer中文件并进行搜索
  • 正常模式下，\+s+s 等价于在当前文件中搜索
  • 正常模式下，\+s+w 等价于在所有文件中搜索

窗口操作

  • 正常模式下，w1等价于最小化其他窗口，最大化当前窗口

  • 正常模式下，wx等价于写入文件并退出

  • 正常模式下，w2等于横向分屏

  • 正常模式下，w2等价于纵向分屏

  • 正常模式下，m-9等价于向左调整窗口

  • 正常模式下，m-0等价于向右调整窗口

  • 正常模式下，m--等价于向上调整窗口

  • 正常模式下，m-=等价于向下调整窗口

跳转操作

  • 正常模式下，\+g+d等价于跳转到定义
  • 正常模式下，\+g+r等价于查找引用函数和变量的地方
  • 正常模式下，\+g+t等价于跳转到类型定义
  • 正常模式下，\+g+i等价于挑战到函数实现

终端操作

  • 终端模式下，ctrl+g等价于退出终端模式
  • 正常模式下，\+t+t等价于终端弹出方式为tab
  • 正常模式下，\+t+f等价于终端弹出方式为浮窗

git操作

  • 正常模式下，\+h+b等价于查看当前行的commit