mirror of
https://github.com/jdhao/nvim-config.git
synced 2025-06-08 14:14:33 +02:00
update README
This commit is contained in:
parent
a3795cd043
commit
905efeb53f
25
README.md
25
README.md
@ -40,22 +40,23 @@ This repo hosts my Nvim configuration for Linux, macOS, and Windows.
|
|||||||
and `ginit.vim` is the additional config file for [GUI client of Nvim](https://github.com/neovim/neovim/wiki/Related-projects#gui).
|
and `ginit.vim` is the additional config file for [GUI client of Nvim](https://github.com/neovim/neovim/wiki/Related-projects#gui).
|
||||||
|
|
||||||
My configurations are heavily documented to make it as clear as possible.
|
My configurations are heavily documented to make it as clear as possible.
|
||||||
While you can download the whole repository and use it, it is not recommended though.
|
While you can clone the whole repository and use it, it is not recommended though.
|
||||||
Good configurations are personal. Everyone should have his or her unique config file.
|
Good configurations are personal. Everyone should have his or her unique config file.
|
||||||
You are encouraged to copy from this repo the part you feel useful and add it to your own Nvim config.
|
You are encouraged to copy from this repo the part you want and add it to your own config.
|
||||||
|
|
||||||
|
**Note that this config is tested against [Nvim v0.7.0 release](https://github.com/neovim/neovim/releases/tag/stable).
|
||||||
|
No backward compatibility is guaranteed.**
|
||||||
|
|
||||||
# Install and setup
|
# Install and setup
|
||||||
|
|
||||||
See [doc here](docs/README.md) on how to install Nvim's dependencies, Nvim itself,
|
See [doc here](docs/README.md) on how to install Nvim's dependencies, Nvim itself,
|
||||||
and how to set up on different platforms (Linux, macOS, and Windows).
|
and how to set up on different platforms (Linux, macOS, and Windows).
|
||||||
|
|
||||||
**This config is tested against [Nvim v0.7.0 release](https://github.com/neovim/neovim/releases/tag/stable).
|
|
||||||
No backward compatibility is guaranteed.**
|
|
||||||
|
|
||||||
# Features #
|
# Features #
|
||||||
|
|
||||||
+ Plugin management via [Packer.nvim](https://github.com/wbthomason/packer.nvim).
|
+ Plugin management via [Packer.nvim](https://github.com/wbthomason/packer.nvim).
|
||||||
+ Code auto-completion via [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) and [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
|
+ Code, snippet, word auto-completion via [nvim-cmp](https://github.com/hrsh7th/nvim-cmp).
|
||||||
|
+ Language server protocol (LSP) support via [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
|
||||||
+ Git integration via [vim-fugitive](https://github.com/tpope/vim-fugitive).
|
+ Git integration via [vim-fugitive](https://github.com/tpope/vim-fugitive).
|
||||||
+ Better escaping from insert mode via [better-escape.vim](https://github.com/jdhao/better-escape.vim).
|
+ Better escaping from insert mode via [better-escape.vim](https://github.com/jdhao/better-escape.vim).
|
||||||
+ Ultra-fast project-wide fuzzy searching via [LeaderF](https://github.com/Yggdroot/LeaderF).
|
+ Ultra-fast project-wide fuzzy searching via [LeaderF](https://github.com/Yggdroot/LeaderF).
|
||||||
@ -63,29 +64,29 @@ No backward compatibility is guaranteed.**
|
|||||||
+ Faster matching pair insertion and jump via [delimitMate](https://github.com/Raimondi/delimitMate).
|
+ Faster matching pair insertion and jump via [delimitMate](https://github.com/Raimondi/delimitMate).
|
||||||
+ Smarter and faster matching pair management (add, replace or delete) via [vim-sandwich](https://github.com/machakann/vim-sandwich).
|
+ Smarter and faster matching pair management (add, replace or delete) via [vim-sandwich](https://github.com/machakann/vim-sandwich).
|
||||||
+ Fast buffer jump via [hop.nvim](https://github.com/phaazon/hop.nvim).
|
+ Fast buffer jump via [hop.nvim](https://github.com/phaazon/hop.nvim).
|
||||||
+ Ultra fast snippet insertion via [Ultisnips](https://github.com/SirVer/ultisnips).
|
+ Powerful snippet insertion via [Ultisnips](https://github.com/SirVer/ultisnips).
|
||||||
+ Beautiful status line via [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim).
|
+ Beautiful statusline via [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim).
|
||||||
+ File tree explorer via [nvim-tree.lua](https://github.com/kyazdani42/nvim-tree.lua).
|
+ File tree explorer via [nvim-tree.lua](https://github.com/kyazdani42/nvim-tree.lua).
|
||||||
+ Better quickfix list with [nvim-bqf](https://github.com/kevinhwang91/nvim-bqf).
|
+ Better quickfix list with [nvim-bqf](https://github.com/kevinhwang91/nvim-bqf).
|
||||||
+ Show search index and count with [nvim-hlslens](https://github.com/kevinhwang91/nvim-hlslens).
|
+ Show search index and count with [nvim-hlslens](https://github.com/kevinhwang91/nvim-hlslens).
|
||||||
+ Command line auto-completion via [wilder.nvim](https://github.com/gelguy/wilder.nvim).
|
+ Command line auto-completion via [wilder.nvim](https://github.com/gelguy/wilder.nvim).
|
||||||
+ Keymap display via [which-key.nvim](https://github.com/folke/which-key.nvim).
|
+ User-defined mapping hint via [which-key.nvim](https://github.com/folke/which-key.nvim).
|
||||||
+ Asynchronous code execution via [asyncrun.vim](https://github.com/skywind3000/asyncrun.vim).
|
+ Asynchronous code execution via [asyncrun.vim](https://github.com/skywind3000/asyncrun.vim).
|
||||||
+ Code highlighting via [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter).
|
+ Code highlighting via [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter).
|
||||||
+ Code editing using true nvim inside browser via [firenvim](https://github.com/glacambre/firenvim).
|
+ Code editing using true nvim inside browser via [firenvim](https://github.com/glacambre/firenvim).
|
||||||
+ Color theme via [vim-gruvbox8](https://github.com/lifepillar/vim-gruvbox8) and other beautiful themes.
|
+ Color theme via [vim-gruvbox8](https://github.com/lifepillar/vim-gruvbox8) and other beautiful themes.
|
||||||
+ Markdown writing and previewing via [vim-markdown](https://github.com/plasticboy/vim-markdown) and [markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim).
|
+ Markdown writing and previewing via [vim-markdown](https://github.com/plasticboy/vim-markdown) and [markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim).
|
||||||
|
+ LaTeX editing and previewing via [vimtex](https://github.com/lervag/vimtex) <sup id="a1">[1](#f1)</sup>.
|
||||||
+ Animated GUI style notification via [nvim-notify](https://github.com/rcarriga/nvim-notify).
|
+ Animated GUI style notification via [nvim-notify](https://github.com/rcarriga/nvim-notify).
|
||||||
+ Smooth scroll experience via [neoscroll](https://github.com/karb94/neoscroll.nvim).
|
+ Smooth scroll experience via [neoscroll](https://github.com/karb94/neoscroll.nvim).
|
||||||
+ Tags navigation via [vista](https://github.com/liuchengxu/vista.vim).
|
+ Tags navigation via [vista](https://github.com/liuchengxu/vista.vim).
|
||||||
+ Code formatting via [Neoformat](https://github.com/sbdchd/neoformat).
|
+ Code formatting via [Neoformat](https://github.com/sbdchd/neoformat).
|
||||||
+ Undo management via [vim-mundo](https://github.com/simnalamburt/vim-mundo)
|
+ Undo management via [vim-mundo](https://github.com/simnalamburt/vim-mundo)
|
||||||
+ LaTeX editing via [vimtex](https://github.com/lervag/vimtex) <sup id="a1">[1](#f1)</sup>.
|
|
||||||
+ ......
|
+ ......
|
||||||
|
|
||||||
# UI Demo
|
# UI Demo
|
||||||
|
|
||||||
For more UI demos, see [here](https://github.com/jdhao/nvim-config/issues/15).
|
For more UI demos, check [here](https://github.com/jdhao/nvim-config/issues/15).
|
||||||
|
|
||||||
## Start screen with alpha-nvim
|
## Start screen with alpha-nvim
|
||||||
|
|
||||||
@ -139,7 +140,7 @@ Go to a string starting with `se`
|
|||||||
|
|
||||||
# Shortcuts
|
# Shortcuts
|
||||||
|
|
||||||
Some of the shortcuts I use frequently is listed here. In the following shortcuts, `<leader>` represents ASCII character `,`.
|
Some of the shortcuts I use frequently are listed here. In the following shortcuts, `<leader>` represents ASCII character `,`.
|
||||||
|
|
||||||
| Shortcut | Mode | platform | Description |
|
| Shortcut | Mode | platform | Description |
|
||||||
|-------------------|---------------|-----------------|------------------------------------------------------------------|
|
|-------------------|---------------|-----------------|------------------------------------------------------------------|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user