网上有关Neovim API的中文资料实在稀缺,在此特意整理一部分
若英文水平过关,可以直接输入指令 :h lua guide
获得Neovim的Lua API相关英文文档
Neovim's Lua API
vim.keymap.set(mode , from_keys, to_expr, opts)
作用:创建一个键位映射
mode:类型:string,映射作用的模式,"n"代表normal,"i"代表insert,"v"代表visual
from_keys:类型:string,则指被映射的按键
to_expr:类型:any,指映射得到的键位,vim表达式,或者Lua函数
opts:类型:table,键位映射有关的设置
vim.api.nvim_create_user_command(commandName, expr)
作用:创建一个用户命令
commandName:类型:string, 命令名(必须首字母大写)
expr:类型:any,命令执行的键位,表达式或者Lua函数
vim.api.nvim_create_autocmd(event, opts)
作用:创建一个自动命令
event:类型:string, 自动命令组(autogroup)
opts:类型:table,相关设置:
pattern: 文件名的pattern
callback: 自动命令的回调函数,可以是键位,vim表达式,或者Lua函数