docs(nvim): add README and :help reference guide
This commit is contained in:
parent
ef1e7af98e
commit
e5a8662c91
40
README.md
40
README.md
|
|
@ -1 +1,41 @@
|
||||||
# nvim
|
# nvim
|
||||||
|
|
||||||
|
Personal Neovim config based on `kickstart.nvim`, with custom plugins and
|
||||||
|
workflows for LSP, Git, and terminal-first editing.
|
||||||
|
|
||||||
|
## Quick checks
|
||||||
|
|
||||||
|
Use these commands after config changes:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
nvim --headless "+qa"
|
||||||
|
nvim --headless "+checkhealth" "+qa"
|
||||||
|
luac -p init.lua lua/custom/**/*.lua
|
||||||
|
```
|
||||||
|
|
||||||
|
## Git workflow keymaps
|
||||||
|
|
||||||
|
- `<leader>gg`: open Neogit UI
|
||||||
|
- `<leader>gd`: open Diffview
|
||||||
|
- `<leader>gD`: close Diffview
|
||||||
|
- `<leader>gf`: file history in Diffview (current file)
|
||||||
|
- `<leader>gF`: repository history in Diffview
|
||||||
|
- `<leader>h...`: hunk actions from Gitsigns (`:which-key <leader>h`)
|
||||||
|
|
||||||
|
## LSP notes
|
||||||
|
|
||||||
|
- Vue support uses `vue_ls` plus `ts_ls` scoped to `vue` filetypes.
|
||||||
|
- `ts_ls` is wired with `@vue/typescript-plugin`, so `vue_ls` can forward
|
||||||
|
TypeScript requests in `.vue` buffers.
|
||||||
|
- `typescript-tools.nvim` remains available for TypeScript/JavaScript workflows.
|
||||||
|
|
||||||
|
## Treesitter notes
|
||||||
|
|
||||||
|
- Uses the current API: `require('nvim-treesitter').setup()`.
|
||||||
|
- Config installs parsers from `ensure_installed` automatically when needed.
|
||||||
|
|
||||||
|
## Help docs
|
||||||
|
|
||||||
|
This repo ships a Vim help doc. After opening Neovim, run:
|
||||||
|
|
||||||
|
- `:help nvim-config`
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,50 @@
|
||||||
|
==============================================================================
|
||||||
|
NVIM CONFIG *nvim-config*
|
||||||
|
*nvimn-config*
|
||||||
|
|
||||||
|
This is a custom Neovim configuration based on kickstart.nvim.
|
||||||
|
|
||||||
|
QUICK CHECKS *nvim-config-quick-checks*
|
||||||
|
|
||||||
|
Run these commands after config changes:
|
||||||
|
|
||||||
|
>
|
||||||
|
nvim --headless "+qa"
|
||||||
|
nvim --headless "+checkhealth" "+qa"
|
||||||
|
luac -p init.lua lua/custom/**/*.lua
|
||||||
|
<
|
||||||
|
|
||||||
|
GIT KEYMAPS *nvim-config-git*
|
||||||
|
|
||||||
|
Core git mappings in normal mode:
|
||||||
|
|
||||||
|
- <leader>gg: open Neogit
|
||||||
|
- <leader>gd: open Diffview
|
||||||
|
- <leader>gD: close Diffview
|
||||||
|
- <leader>gf: Diffview file history for current file
|
||||||
|
- <leader>gF: Diffview repository history
|
||||||
|
- <leader>h...: Gitsigns hunk actions
|
||||||
|
|
||||||
|
Use |which-key| with <leader>g and <leader>h to discover more actions.
|
||||||
|
|
||||||
|
LSP: VUE + TYPESCRIPT *nvim-config-vue*
|
||||||
|
|
||||||
|
Vue buffers rely on both:
|
||||||
|
|
||||||
|
- `vue_ls` for Vue language features
|
||||||
|
- `ts_ls` (filetype-scoped to `vue`) with `@vue/typescript-plugin`
|
||||||
|
|
||||||
|
This pairing allows `vue_ls` to forward TypeScript requests for `.vue` files.
|
||||||
|
|
||||||
|
TREESITTER *nvim-config-treesitter*
|
||||||
|
|
||||||
|
This config uses the current nvim-treesitter API:
|
||||||
|
|
||||||
|
>
|
||||||
|
require('nvim-treesitter').setup()
|
||||||
|
<
|
||||||
|
|
||||||
|
Configured parsers are installed from `ensure_installed` as needed.
|
||||||
|
|
||||||
|
==============================================================================
|
||||||
|
vim:tw=78:ts=8:ft=help:norl:
|
||||||
6
doc/tags
6
doc/tags
|
|
@ -1,3 +1,9 @@
|
||||||
kickstart-is kickstart.txt /*kickstart-is*
|
kickstart-is kickstart.txt /*kickstart-is*
|
||||||
kickstart-is-not kickstart.txt /*kickstart-is-not*
|
kickstart-is-not kickstart.txt /*kickstart-is-not*
|
||||||
kickstart.nvim kickstart.txt /*kickstart.nvim*
|
kickstart.nvim kickstart.txt /*kickstart.nvim*
|
||||||
|
nvim-config nvim.txt /*nvim-config*
|
||||||
|
nvim-config-git nvim.txt /*nvim-config-git*
|
||||||
|
nvim-config-quick-checks nvim.txt /*nvim-config-quick-checks*
|
||||||
|
nvim-config-treesitter nvim.txt /*nvim-config-treesitter*
|
||||||
|
nvim-config-vue nvim.txt /*nvim-config-vue*
|
||||||
|
nvimn-config nvim.txt /*nvimn-config*
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue