first commit

README.md

@@ -1,2 +1,52 @@
-# nvim-lua-guide-zh
-https://github.com/nanotee/nvim-lua-guide chinese version
+# 在neovim中使用Lua
+
+## 目录
+
+* [简介](#introduction)
+  * [学习 Lua](#learning-lua)
+  * [其他关于在neovim中使用lua的教程](#existing-tutorials-for-writing-lua-in-neovim)
+  * [相关的插件](#companion-plugins)
+* [Lua文件的位置](#where-to-put-lua-files)
+    * [警告](#caveats)
+    * [提示](#tips)
+    * [包说明](#a-note-about-packages)
+* [在Vim文件中调用Lua](#using-lua-from-vimscript)
+  * [:lua](#lua)
+    * [Caveats](#caveats-1)
+  * [:luado](#luado)
+  * [:luafile](#luafile)
+    * [luafile vs require():](#luafile-vs-require)
+  * [luaeval()](#luaeval)
+  * [v:lua](#vlua)
+    * [Caveats](#caveats-2)
+* [Vim命名空间](#the-vim-namespace)
+    * [Tips](#tips-1)
+* [在Lua中调用vimscript](#using-vimscript-from-lua)
+  * [vim.api.nvim_eval()](#vimapinvim_eval)
+    * [Caveats](#caveats-3)
+  * [vim.api.nvim_exec()](#vimapinvim_exec)
+  * [vim.api.nvim_command()](#vimapinvim_command)
+    * [Tips](#tips-2)
+* [管理vim设置选项](#managing-vim-options)
+  * [使用api函数](#using-api-functions)
+  * [使用元访问器](#using-meta-accessors)
+    * [Caveats](#caveats-4)
+* [管理vim内部变量](#managing-vim-internal-variables)
+  * [使用api函数](#using-api-functions-1)
+  * [使用元访问器](#using-meta-accessors-1)
+    * [Caveats](#caveats-5)
+* [调用vimscript函数](#calling-vimscript-functions)
+  * [vim.call()](#vimcall)
+  * [vim.fn.{function}()](#vimfnfunction)
+    * [Tips](#tips-3)
+    * [Caveats](#caveats-6)
+* [定义键位映射](#defining-mappings)
+* [定义用户命令](#defining-user-commands)
+* [定义自动命令](#defining-autocommands)
+* [定义语法高亮](#defining-syntaxhighlights)
+* [一般提示和备注](#general-tips-and-recommendations)
+* [杂项](#miscellaneous)
+  * [vim.loop](#vimloop)
+  * [vim.lsp](#vimlsp)
+  * [vim.treesitter](#vimtreesitter)
+  * [Transpilers](#transpilers)