Neovim - 简单入门

前排提示：我采用的配置是基于这个配置进行改进的，如果对 Neovim 和 LaTeX 有基本的使用经验可以直接参考给出的链接。

如果对哪些部分不清楚或者对某个部分的具体实现感兴趣，可以私信或者评论，我会针对内容进行更新。

最终效果展示：

为什么有这篇文章

在写这篇文章之前，我已经使用 Vim （主要是用的 VS Code 的 Neovim 插件）和 \(\LaTeX\) 一段时间了，之前一直都是使用 VS Code 和 \(\LaTeX\) 插件的解决方案，但是最终还是觉得 Neovim 的实现更加优雅，也更符合我的习惯和解决我的一些痛点：：

  • 经常使用 Windows Terminal
  • VS Code 的 Neovim 插件时不时会遇到一些无法解决的 Bug
  • 使用 Neovim 插件没办法实现一些自定义的操作和更改配置，这点在我要增加一些功能的时候尤为难受
  • 加快启动和编译的速度，特别是针对大文件
  • 保留上个世纪程序员的炫酷

参考了很多解决方案，都没有一个比较完美的符合我痛点的配置，于是只好自己根据现有的解决方案改良了一下，主要的功能有：

  • 语法高亮
  • \(\LaTeX\) 正向搜索、反向搜索
  • 文件检索、模糊查找
  • 整合 Lazygit 实现版本管理
  • 采用 Lua 编写，更加符合 Neovim 的习惯
  • 利用 VimTeX 实现编译、查看 \(\LaTeX\) 文件
  • 支持 LSP 自动补全
  • 格式化代码
  • 支持中英输入法混用（在 Normal 模式英文输入法，在 Insert 模式下中文输入法）
  • ……

什么是 Neovim

如果你听过编辑器之神 Vim 和神之编辑器 Emacs 的话，那么就很好理解 Neovim 了，它就是 Vim 的一个社区版，如果你对它的历史感兴趣，可以到 Neovim 的官网 查看。

关于 Vim 和 Neovim 的历史还可以查看：Vim 和 Neovim 的前世今生 · jdhao's digital space

一些可能有用的链接

快速入门

快捷键速查表

在哪里找插件

学习 Vim & Neovim

配置 Neovim

第三方博客的介绍：

中文博客

英文博客

为什么是 Neovim 而不是 Vim

遇到问题请看我

一些建议

其他链接

安装 Neovim

由于我使用 Windows 10 的 scoop 软件来管理安装其他软件，所以只需要一行命令就能安装：

1
scoop install main/neovim

如果是其他的安装方法可以参考官方文档。

如果你还不熟悉 Vim 的操作，可以打开 Neovim，然后进入命令模式，输入下面的代码就可以进入一个大概30分钟的交互式教程：

1
:Tutor

配置 Neovim

无论是开箱即用还是自己配置，最终目的都是为了方便自己，切莫本末倒置。也不必追求一次性就将自己的配置做到最优，可以在使用中发现缺少什么再去补全，这样会使得整个过程更加容易一些，当然如果想要体验一下完全体还是建议先下载几个开箱即用的配置试试看。

开箱即用

如果不想自己配置 Neovim 也有很多开箱即用的配置可以参考：

打造属于自己的 Neovim

Windows 10 中 Neovim 的配置文件一般在 ~/AppData/Local/nvim/init.vim (Windows) 这个路径下， ~ 表示当前用户的目录，比如用户名为 Beta 的用户的路径一般为 C:/Users/Abel/AppData/Local/nvim/init.vim 。Neovim 启动时会加载 init.vim 文件，所以只需要在这个文件中进行配置就可以。

我的配置文件会加上大部分的注释，基本上是自解释的，如果还有不懂的部分，比如 o 和 g 分别是什么，可以参考官方给出的文档，下面给出我的配置文件的结构，以下默认当前文件夹是在前面提到的 ./nvim 下：

1
2
3
4
5
6
7
8
9
10
11
12
13
~/AppData/Local/nvim
│   init.lua -- 自动加载
│   lazy-lock.json
│   
│   
└───lua
    ├───config --存放配置文件
    │       keymaps.lua -- 按键映射设置
    │       lazy.lua -- lazy.nvim 懒加载插件用于管理插件
    │       options.lua -- 原生 Neovim 支持的设置
    │       
    └───plugins

如何生成文件树：利用 Windows 10 的 tree 命令：

1
tree /f >tree.txt

会将当前目录下的文件树的结果导出到 tree.txt 文件中，如果没有这个文件则会创建文件并写入结果。

配置文件

init.lua 文件是 Neovim 启动时会加载的配置文件，可以按照文件树结构来安排各种设置，便于分类和查找：

1
2
3
4
5
6
-- ---------- 本地配置 ---------- --
require("config.options") -- 选项
require("config.keymaps") -- 按键设置

-- ---------- 插件管理 ---------- --
require("config.lazy") -- Lazy.nvim 进行插件管理

options.lua 文件主要放了 Neovim 原本就支持的一些设置，包括行号、高亮、编码等等，所以会显得比较杂乱：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
-- local g = vim.g
-- local opt = vim.opt

-- opt.completeopt = "menu, menuone, noselect, noinsert", -- 补全选项设置

-- leader 按键设置
-- g.mapleader = " "
-- g.maplocalleader = "\\"

local options = {

  -- GENERAL
  timeoutlen = 500,               -- time to wait for a mapped sequence to complete (in milliseconds), 键盘快捷键等待时间
  updatetime = 300,               -- faster completion (4000ms default), 更新检查间隔时间
  swapfile = false,               -- creates a swapfile, 禁止创建 swap 文件
  undofile = true,                -- enable persistent undo
  writebackup = false,            -- if a file is being edited by another program, it is not allowed to be edited, 禁止写入备份文件
  backup = false,  				  -- 禁止创建备份文件
  confirm = true,  				  -- 没有保存或文件只读时弹出确认

  -- APPEARANCE
  fileencoding = "utf-8",         -- the encoding written to a file, 保存文件的时候使用 UTF-8 编码
  encoding = "UTF-8", 			  -- 当处理文本的时候使用 UTF-8 编码
  -- guifont = "monospace:h17",      -- the font used in graphical neovim applications
  background = "dark",            -- colorschemes that can be light or dark will be made dark, 设置背景为暗色
  termguicolors = true,           -- set term gui colors (most terminals support this), 开启终端真彩色支持
  conceallevel = 0,               -- so that `` is visible in markdown files
  number = true,                  -- set numbered lines, 显示行号
  relativenumber = true,          -- set relative numbered lines, 使用相对行号
  -- numberwidth = 2,                -- set number column width to 2 {default 4}
  signcolumn = "yes",             -- always show the sign column, otherwise it would shift the text each time, 左侧始终显示符号列
  cursorline = true,              -- highlight the current line, 高亮当前行
  -- colorcolumn = "100",             -- highlight vertical colorcolumn (moved to after/python.lua), 右侧第 100 列显示颜色参考线
  wrap = true,                    -- display lines as one long line, 启用折行
  showbreak = "  ",               -- set indent of wrapped lines
  cmdheight = 1,                  -- space in the neovim command line for displaying messages, 命令行高度
  pumheight = 10,                 -- pop up menu height, 补全菜单高度为 10 行
  wildmenu = true, 				  -- 显示补全菜单
  -- showmode = false,               -- we don't need to see things like -- INSERT -- anymore
  splitbelow = true,              -- force all horizontal splits to go below current window, 水平分屏默认在下方
  splitright = true,              -- force all vertical splits to go to the right of current window, 垂直分屏默认在右侧
  scrolloff = 999,                  -- minimal number of screen lines to keep above and below the cursor, 光标上下保持 999 行距离，实现类似 Typora 的打字机的效果
  sidescrolloff = 8,              -- minimal number of screen columns either side of cursor if wrap is `false`, 光标左右保持 8 列距离
  shortmess = "filnxtToOFc",      -- which errors to suppress
  mousemoveevent = true,
  -- shortmess:append "atI", 		  -- 隐去启动的提示信息

  -- INDENT
  tabstop = 4,                    -- insert 4 spaces for a tab, Tab 键相当于 4 个空格
  shiftwidth = 4,                 -- the number of spaces inserted for each indentation, 自动缩进时移动 4 个空格
  softtabstop = 4,                -- insert 2 spaces for a tab, 编辑时 Tab 键为 4 个空格
  expandtab = true,               -- convert tabs to spaces, Tab 替换为空格
  breakindent = true,             -- tab wrapped lines
  linebreak = true,               -- companion to wrap, don't split words
  backspace = "indent,eol,start", -- allow backspace on indent, end of line or insert mode start position
  smarttab = true, 				  -- 开启智能 Tab
  shiftround = true,              -- 使用 >> 和 << 移动时对齐到 shiftwidth 的倍数
  cindent = true,				  -- C 文件自动缩进
  autoindent = true,			  -- 新行缩进对齐到当前行
  smartindent = true,			  -- 开启智能缩进

  -- EDIT
  -- spell = true,                   -- turns on spellchecker, 支持拼写检查
  -- spelllang = { 'en_us', 'cjk' },        -- sets spelling dictionary, 对英文进行拼写检查, 忽略中文的拼写检查
  clipboard = "unnamedplus",      -- allows neovim to access the system clipboard, 使用系统剪贴板
  mouse = "a",                    -- allow the mouse to be used in neovim, 开启鼠标支持
  mousescroll = "ver:2,hor:4",    -- change the speed of the scroll wheel
  ignorecase = true,              -- ignore case in search patterns, 搜索时不区分大小写
  smartcase = true,               -- smart case, 搜索包含大写字母时，自动区分大小写
  hlsearch = true, 				  -- 搜索高亮
  incsearch = true, 			  -- 输入搜索模式时，每输入一个字符，就自动跳到第一个匹配的结果
  showmatch = true, 			  -- 高亮匹配的括号
  virtualedit = "block",          -- vitualblock mode doesn't get stuck at the end of line
  inccommand = "split",           -- shows all inline replacements in split
  autoread = true,				  -- 外部文件修改自动加载
  whichwrap = "<,>,[,]",		  -- 光标移到行首或行尾时，可跨行移动
  list = false,					  -- 不显示不可见字符
  listchars = "space:·,tab:>-",   -- 空格和 Tab 的显示方式

}

-- turns on all values in options table above
for k, v in pairs(options) do
  vim.opt[k] = v
end

在 Neovim/Vim 中直接输入 / 就可以查找，比如 /include 就是查找文件中包含 include 的词，同样有大小写敏感，要关闭大小写敏感，可以使用命令 vim.o.ignorecase = true。

查看查找的历史记录可以输入 / 之后用方向键来查找之前查找的记录。当然这需要在查找之后按下回车进行实际的查找才会进行记录，否则如果只是在命令中查找而不按下回车键是不会进行记录的。

如果记得之前查找历史中的某个开头的字母，比如之前运用过 /search 命令查找了 search 这个单词，然后之后又进行了多次查询，并且在查询之后都按下了回车键，这会把查找历史记录下来，那么想要快速找到之前的某个查找记录，那么就可以先输入 /sea 然后按下方向键就可以在以 sea 开头的查找记录中跳转。

当然 : 的命令模式也有类似以上的功能，但是 : 命令的历史记录和 / 命令的历史记录是分开的。

搜索当前光标指示的单词，当然可以使用 / 命令手动输入当前光标所指示的单词，但是也可以用 * 来直接搜索当前光标所指示的单词在文本中出现的下一个位置，这样不容易在 / 输入中拼写错误，而 # 命令向相反的方向做同样的事情。不过这两个命令会自动进行全字匹配，如果想要部分匹配的话可以用命令 g# 和 g* 。

keymaps.lua 主要存放一些经常用的快捷键（可以自己设置）：

1
-- 暂时还没有

lazy.lua 文件是一个管理 Neovim 插件的插件，具体的设置可以参考官方文档：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
-- 安装 lazy.nvim 插件
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then
  local lazyrepo = "https://github.com/folke/lazy.nvim.git"
  local out = vim.fn.system({
  				"git", 
  				"clone", 
  				"--filter=blob:none", 
  				"--branch=stable", 
  				lazyrepo, 
  				lazypath })
  if vim.v.shell_error ~= 0 then
    vim.api.nvim_echo({
      { "Failed to clone lazy.nvim:\n", "ErrorMsg" },
      { out, "WarningMsg" },
      { "\nPress any key to exit..." },
    }, true, {})
    vim.fn.getchar()
    os.exit(1)
  end
end
vim.opt.rtp:prepend(lazypath)

-- 设置 lazy.nvim 插件
require("lazy").setup({
  spec = {
    -- 安装插件
    -- VimTeX 主要用于支持 LaTeX 的功能
    {
      "lervag/vimtex",
      lazy = false,     -- VimTeX 不需要懒加载
      -- tag = "v2.15", -- 取消注释以固定在某个版本
      init = function()
        -- 下面是有关 VimTeX 的设置
        -- VimTeX 在 Windows 中如果能找到 SumatraPDF 就会自动设置用它打开
        -- vim.g.vimtex_view_method = "SumatraPDF"
      end
    },
  },  
  checker = { enabled = true }, -- 自动检查插件更新
  -- 不想使用 Nerd Font，用Unicode的图标替代
  ui = {
    icons = { -- 各种元素的图标配置
      cmd = "⌘",
      config = "🛠",
      event = "📅",
      ft = "📂",
      init = "⚙",
      keys = "🗝",
      plugin = "🔌",
      runtime = "💻",
      require = "🌙",
      source = "📄",
      start = "🚀",
      task = "📌",
      lazy = "💤 ",
    },
  },

这里有个坑，安装 lazy.nvim 是要先安装 git 的，而且安装之后在 Neovim 中执行 :checkhealth lazy 时可能会遇到和 luarocks 有关的报错，我的解决方案是通过 Scoop 安装 luarocks 和 lua：

1
2
scoop install main/luarocks
scoop install main/lua

插件

lazy.nvim：用于插件管理的一个插件，可以进行快速地安装、卸载、更新插件。

vimtex：Vimtex 是一个专门为 Vim 和 Neovim 设计的 LaTeX 插件，它提供了包括语法高亮、自动补全、编译支持、预览和错误检查等功能。

进阶版 Neovim

结合 Neovim 和 \(\LaTeX\)

可以参考的链接

我的解决方案

根据这个配置进行改进

keymaps.lua 的内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
local opts = { noremap = true, silent = true } -- noremap 禁止递归映射，silent 禁止显示命令。

-- local term_opts = { silent = true }

-- Shorten function name
local keymap = vim.api.nvim_set_keymap
-- local map = vim.keymap.set -- for conciseness

--Remap space as leader key
vim.g.mapleader = " " -- 设置空格为 Leader Key
-- vim.g.maplocalleader = " "


-------------------- General Keymaps --------------------

-- delete single character without copying into register
-- keymap("n", "x", '"_x', opts)
-- keymap("v", "p", '"_p', opts)

-- Unmappings 解绑快捷键,<C-z>、gc、gcc 被设置为无操作（<nop>）,用于禁用这些快捷键。
keymap("n", "<C-z>", "<nop>", opts)
keymap("n", "gc", "<nop>", opts)
keymap("n", "gcc", "<nop>", opts)

-- NOTE: not sure I will uses these cmp-vimtex commands
-- Search from hovering over cmp-vimtex citation completion
-- vim.keymap.set("i", "<C-z>", function() 
--   require('cmp_vimtex.search').search_menu()
-- end)
-- vim.keymap.set("i", "<C-z>", function() 
--   require('cmp_vimtex.search').perform_search({ engine = "arxiv" })
-- end)

-- NOTE: prefer to use whichkey
-- Surround 
-- vim.keymap.set("v", '<C-s>', 'S', { remap = true }) -- see surround.lua


-- Spelling "<C-s>" 调用 telescope 插件的 spell_suggest，提供拼写建议，光标处展示一个小窗口。
vim.keymap.set("n", "<C-s>", function()
  require("telescope.builtin").spell_suggest(require("telescope.themes").get_cursor({
      previewer = false,
      layout_config = {
        width = 50,
        height = 15,
      }
    })
  )
end, { remap = true })
-- vim.keymap.set("n", "<C-s>", "z=", { remap = true}) 
-- keymap("n", "<C-s>", "<cmd>Telescope spell_suggest<cr>", { remap = true})

-- Kill search highlights 按 <Enter> 清除高亮显示的搜索结果。
keymap("n", "<CR>", "<cmd>noh<CR>", opts)


-- Find project files <Ctrl-p> 启动 Telescope 插件中的 find_files 函数，用于查找项目文件。
vim.keymap.set("n", "<C-p>", "<cmd>Telescope find_files<CR>", { remap = true })
  -- function ()
  --   require('telescope.builtin').find_files(require('telescope.themes').get_dropdown({previewer = false}))
  -- end, 


-- Toggle comments <Ctrl-/> 用于切换当前行和选择区域的行注释。
keymap('n', '<C-_>', '<Plug>(comment_toggle_linewise_current)', opts)
keymap('x', '<C-_>', '<Plug>(comment_toggle_linewise_visual)', opts)


-- Open help on word 按 <Shift-m> 打开光标处单词的帮助文档。
keymap("n", "<S-m>", ':execute "help " . expand("<cword>")<cr>', opts)


-- Fix 'Y', 'E' Y 键重新映射为复制到行尾，E 映射为跳转到上一个单词结尾。
keymap("n", "Y", "y$", opts)
keymap("n", "E", "ge", opts)
keymap("v", "Y", "y$", opts)
keymap("v", "E", "ge", opts) -- causes errors with luasnip autocmp


-- Better window navigation 使用 <C-h>, <C-j>, <C-k>, <C-l> 快速在窗口间导航。
keymap("n", "<C-h>", "<C-w>h", opts)
keymap("n", "<C-j>", "<C-w>j", opts)
keymap("n", "<C-k>", "<C-w>k", opts)
keymap("n", "<C-l>", "<C-w>l", opts)


-- Resize with arrows <A-Left> 和 <A-Right> 用于调整窗口宽度。
-- keymap("n", "<C-Up>", ":resize -2<CR>", opts)
-- keymap("n", "<C-Down>", ":resize +2<CR>", opts)
-- keymap("n", "<A-Left>", ":vertical resize -2<CR>", opts)
-- keymap("n", "<A-Right>", ":vertical resize +2<CR>", opts)
-- keymap("n", "<A-h>", ":vertical resize -2<CR>", opts)
-- keymap("n", "<A-l>", ":vertical resize +2<CR>", opts)


-- Navigate buffers <TAB> 和 <S-TAB> 在缓冲区之间切换。
-- keymap("n", "<TAB>", ":bnext<CR>", opts)
-- keymap("n", "<S-TAB>", ":bprevious<CR>", opts)
-- keymap("n", "<BS>", ":BufferLineMoveNext<CR>", opts)
-- keymap("n", "<S-BS>", ":BufferLineMovePrev<CR>", opts)


-- Drag lines <Alt-j> 和 <Alt-k> 用于拖动行。
keymap("n", "<A-j>", "<Esc>:m .+1<CR>==", opts)
keymap("n", "<A-k>", "<Esc>:m .-2<CR>==", opts)
keymap("x", "<A-j>", ":move '>+1<CR>gv-gv", opts)
keymap("x", "<A-k>", ":move '<-2<CR>gv-gv", opts)
keymap("v", "<A-j>", ":m'>+<CR>gv", opts)
keymap("v", "<A-k>", ":m-2<CR>gv", opts)

-- Horizontal line movments -- <S-h> 和 <S-l> 用于跳到行的开头和结尾。
keymap("v", "<S-h>", "g^", opts)
keymap("v", "<S-l>", "g$", opts)
keymap("n", "<S-h>", "g^", opts)
keymap("n", "<S-l>", "g$", opts)

options.lua 的内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
local options = {

  -- GENERAL
  timeoutlen = 500,               -- time to wait for a mapped sequence to complete (in milliseconds), 键盘快捷键等待时间
  updatetime = 300,               -- faster completion (4000ms default), 更新检查间隔时间
  swapfile = false,               -- creates a swapfile, 禁止创建 swap 文件
  undofile = true,                -- enable persistent undo
  writebackup = false,            -- if a file is being edited by another program, it is not allowed to be edited, 禁止写入备份文件
  backup = false,           -- 禁止创建备份文件
  confirm = true,           -- 没有保存或文件只读时弹出确认

  -- APPEARANCE
  fileencoding = "UTF-8",         -- the encoding written to a file, 保存文件的时候使用 UTF-8 编码
  encoding = "UTF-8",             -- 当处理文本的时候使用 UTF-8 编码
  -- guifont = "monospace:h17",      -- the font used in graphical neovim applications
  background = "dark",            -- colorschemes that can be light or dark will be made dark, 设置背景为暗色
  termguicolors = true,           -- set term gui colors (most terminals support this), 开启终端真彩色支持
  conceallevel = 0,               -- so that `` is visible in markdown files
  number = true,                  -- set numbered lines, 显示行号
  relativenumber = true,          -- set relative numbered lines, 使用相对行号
  numberwidth = 2,                -- set number column width to 2 {default 4}
  signcolumn = "yes",             -- always show the sign column, otherwise it would shift the text each time, 左侧始终显示符号列
  cursorline = true,              -- highlight the current line, 高亮当前行
  -- colorcolumn = "100",             -- highlight vertical colorcolumn (moved to after/python.lua), 右侧第 100 列显示颜色参考线
  wrap = true,                    -- display lines as one long line, 启用折行
  showbreak = "  ",               -- set indent of wrapped lines
  cmdheight = 1,                  -- space in the neovim command line for displaying messages, 命令行高度
  pumheight = 10,                 -- pop up menu height, 补全菜单高度为 10 行
  wildmenu = true,                -- 显示补全菜单
  -- showmode = false,               -- we don't need to see things like -- INSERT -- anymore
  splitbelow = true,              -- force all horizontal splits to go below current window, 水平分屏默认在下方
  splitright = true,              -- force all vertical splits to go to the right of current window, 垂直分屏默认在右侧
  scrolloff = 999,                  -- minimal number of screen lines to keep above and below the cursor, 光标上下保持 999 行距离，实现类似 Typora 的打字机的效果
  sidescrolloff = 8,              -- minimal number of screen columns either side of cursor if wrap is `false`, 光标左右保持 8 列距离
  -- shortmess = "filnxtToOFc",      -- which errors to suppress
  -- mousemoveevent = true,
  -- shortmess:append "atI",      -- 隐去启动的提示信息

  -- INDENT
  tabstop = 4,                    -- insert 4 spaces for a tab, Tab 键相当于 4 个空格
  shiftwidth = 4,                 -- the number of spaces inserted for each indentation, 自动缩进时移动 4 个空格
  softtabstop = 4,                -- insert 2 spaces for a tab, 编辑时 Tab 键为 4 个空格
  expandtab = true,               -- convert tabs to spaces, Tab 替换为空格
  breakindent = true,             -- tab wrapped lines
  linebreak = true,               -- companion to wrap, don't split words
  backspace = "indent,eol,start", -- allow backspace on indent, end of line or insert mode start position
  smarttab = true,                -- 开启智能 Tab
  shiftround = true,              -- 使用 >> 和 << 移动时对齐到 shiftwidth 的倍数
  cindent = true,                 -- C 文件自动缩进
  autoindent = true,              -- 新行缩进对齐到当前行
  smartindent = true,             -- 开启智能缩进

  -- EDIT
  -- spell = true,                   -- turns on spellchecker, 支持拼写检查
  -- spelllang = { 'en_us', 'cjk' },        -- sets spelling dictionary, 对英文进行拼写检查, 忽略中文的拼写检查
  clipboard = "unnamedplus",      -- allows neovim to access the system clipboard, 使用系统剪贴板
  mouse = "a",                    -- allow the mouse to be used in neovim, 开启鼠标支持
  -- mousescroll = "ver:2,hor:4",    -- change the speed of the scroll wheel
  ignorecase = true,              -- ignore case in search patterns, 搜索时不区分大小写
  smartcase = true,               -- smart case, 搜索包含大写字母时，自动区分大小写
  hlsearch = true,                -- 搜索高亮
  incsearch = true,               -- 输入搜索模式时，每输入一个字符，就自动跳到第一个匹配的结果
  showmatch = true,               -- 高亮匹配的括号
  virtualedit = "block",          -- vitualblock mode doesn't get stuck at the end of line
  inccommand = "split",           -- shows all inline replacements in split
  autoread = true,                -- 外部文件修改自动加载
  whichwrap = "<,>,[,]",          -- 光标移到行首或行尾时，可跨行移动
  list = false,                   -- 不显示不可见字符
  listchars = "space:·,tab:>-",   -- 空格和 Tab 的显示方式

}

-- turns on all values in options table above
for k, v in pairs(options) do
  vim.opt[k] = v
end

autocmds.lua 的内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
local api = vim.api

-- close help, man, qf, lspinfo with 'q' 为 man、help、qf 和 lspinfo 文件类型创建自动命令，按 q 关闭这些窗口，便于查看后快速退出。
api.nvim_create_autocmd(
  "FileType",
  {
    pattern = { "man", "help", "qf", "lspinfo" }, -- "startuptime",
    command = "nnoremap <buffer><silent> q :close<CR>",
  }
)

-- Terminal mappings 
--[[
定义了 set_terminal_keymaps 函数，在终端模式中设置快捷键：<esc> 映射为 <C-c>，可用来快速退出终端模式。
<C-h>, <C-j>, <C-k>, <C-l> 在不同窗口之间导航。当打开终端时（TermOpen），自动调用 set_terminal_keymaps()。
]]
function _G.set_terminal_keymaps()
  local opts = { buffer = 0 }
  vim.keymap.set('t', '<esc>', [[<C-c>]], opts)
  vim.keymap.set('t', '<C-h>', [[<Cmd>wincmd h<CR>]], opts)
  vim.keymap.set('t', '<C-j>', [[<Cmd>wincmd j<CR>]], opts)
  vim.keymap.set('t', '<C-k>', [[<Cmd>wincmd k<CR>]], opts)
  vim.keymap.set('t', '<C-l>', [[<Cmd>wincmd l<CR>]], opts)
  -- vim.keymap.set('t', '<C-w>', [[<C-\><C-n><C-w>]], opts)
end

vim.api.nvim_create_autocmd({ "TermOpen" }, {
  pattern = { "term://*" }, -- use term://*toggleterm#* for only ToggleTerm
  command = "lua set_terminal_keymaps()",
})

-- Autolist markdown mappings
--[[
在 Markdown 文件中自动设置键映射，用于管理有序或无序列表：
<CR>、o、O 用于插入新列表项。
<tab>、<S-tab> 在插入模式下重新计算列表缩进。
dd、d 删除列表项并重新计算。
设置 tabstop、shiftwidth 和 softtabstop 为 2 个空格，符合 Markdown 语法要求。
]]
function _G.set_markdown_keymaps()
  vim.api.nvim_buf_set_keymap(0, "i", "<CR>", "<CR><cmd>AutolistNewBullet<cr>", {})
  vim.api.nvim_buf_set_keymap(0, "n", "o", "o<cmd>AutolistNewBullet<cr>", {})
  vim.api.nvim_buf_set_keymap(0, "n", "O", "O<cmd>AutolistNewBulletBefore<cr>", {})
  vim.api.nvim_buf_set_keymap(0, "i", "<tab>", "<Esc>><cmd>AutolistRecalculate<cr>a<space>", {})
  vim.api.nvim_buf_set_keymap(0, "i", "<S-tab>", "<Esc><<cmd>AutolistRecalculate<cr>a", {})
  vim.api.nvim_buf_set_keymap(0, "n", "dd", "dd<cmd>AutolistRecalculate<cr>", {})
  vim.api.nvim_buf_set_keymap(0, "v", "d", "d<cmd>AutolistRecalculate<cr>", {})
  vim.api.nvim_buf_set_keymap(0, "n", ">", "><cmd>AutolistRecalculate<cr>", {})
  vim.api.nvim_buf_set_keymap(0, "n", "<", "<<cmd>AutolistRecalculate<cr>", {})
  vim.api.nvim_buf_set_keymap(0, "n", "<C-c>", "<cmd>AutolistRecalculate<cr>", {})
  vim.api.nvim_buf_set_keymap(0, "n", "<C-n>", "<cmd>lua HandleCheckbox()<CR>", {})
  vim.opt.tabstop = 2
  vim.opt.shiftwidth = 2
  vim.opt.softtabstop = 2
end

vim.api.nvim_create_autocmd({ "BufEnter", "BufReadPre", "BufNewFile" }, {
  pattern = { "*.md" },
  command = "lua set_markdown_keymaps()",
})

functions.lua 的内容：

1
2
3
4
5
-- 用于在 Neovim 中查找光标下的单词，具体功能如下：
function SearchWordUnderCursor()
    local word = vim.fn.expand('<cword>') -- 获取光标下的单词
    require('telescope.builtin').live_grep({ default_text = word }) -- 调用 Telescope 插件的 live_grep 功能
end

bootstrap.lua 的内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
-- BOOTSTRAP LAZY
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
  vim.fn.system({
    "git",
    "clone",
    "--filter=blob:none",
    "https://github.com/folke/lazy.nvim.git",
    "--branch=stable", -- latest stable release
    lazypath,
  })
end
vim.opt.rtp:prepend(lazypath)

require("lazy").setup({
  { import = "neotex.plugins" },    -- main plugins directory
  { import = "neotex.plugins.lsp" } -- lsp plugins directory
}, {
  install = {
    colorscheme = { "gruvbox" },
  },
  checker = {
    enabled = true,
    notify = false,
  },
  change_detection = {
    notify = false, 
  },
  ui = {
    icons = {
      cmd = "⌘",
      config = "🛠",
      event = "📅",
      ft = "📂",
      init = "⚙",
      keys = "🗝",
      plugin = "🔌",
      runtime = "💻",
      require = "🌙",
      source = "📄",
      start = "🚀",
      task = "📌",
      lazy = "💤 ",
    },
  },
})

遇到的一些问题及其解答：

  • 快捷键如何映射正斜杠：使用 _ 代替 /[1]。
插件介绍

References

  1. key bindings - Is it possible to map control forward-slash with vim - Vi and Vim Stack Exchange ↩︎
Tools > Neovim
#Tool #Vim #Neovim
Neovim - 简单入门
https://chen-huaneng.github.io/2024/10/25/2024-10-25-2024-10-25-neovim/
作者
Abel
发布于
2024年10月25日
更新于
2024年10月28日
许可协议