From d9a3aaf058597776a114ecb574a0264492c841ab Mon Sep 17 00:00:00 2001 From: jdhao Date: Wed, 22 Apr 2020 23:25:35 +0800 Subject: [PATCH] docs: update README --- README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 5889c99..654030d 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ itself and the configuration on different platforms (Linux, MacOS and Windows). + Source code linting via [Neomake](https://github.com/neomake/neomake). + Code formatting via [Neoformat](https://github.com/sbdchd/neoformat). + Markdown writing and syntax highlighting via [vim-markdown](https://github.com/plasticboy/vim-markdown) and [vim-pandoc-syntax](https://github.com/vim-pandoc/vim-pandoc-syntax). -+ LaTeX editing via [vimtex](https://github.com/lervag/vimtex). ++ LaTeX editing via [vimtex](https://github.com/lervag/vimtex)[^1]. + Git integration via [vim-fugitive](https://github.com/tpope/vim-fugitive). + Fast buffer jump via [vim-sneak](https://github.com/justinmk/vim-sneak). + Open a file in current project quickly via [LeaderF](https://github.com/Yggdroot/LeaderF). @@ -35,20 +35,22 @@ itself and the configuration on different platforms (Linux, MacOS and Windows). # Shortcuts -In the following shortcuts, `` represents `,` character. +In the following shortcuts, `` represents the `,` character. -| Shortcut | Description | -|-------------------|---------------------------------------------------------------| -| `f` | Open file fuzzy search in floating window and starting search | -| `` | Remove trailing whitespaces | -| `v` | Reselect last pasted text | -| `ev` | Edit Neovim config in a new tabpage | -| `sv` | Reload Neovim config | -| `q` | Quit current window | -| `Q` | Quit all window and close Neovim | -| `w` | Save current buffer content | -| `s` | Toggle the sidebar (show project tree view) | -| `t` | Toggle tag window (show project tags in the right window) | +| Shortcut | Description | +|-------------------|-----------------------------------------------------------------| +| `f` | Open fuzzy file search in a floating window and starting search | +| `` | Remove trailing whitespaces | +| `v` | Reselect last pasted text | +| `ev` | Edit Neovim config in a new tabpage | +| `sv` | Reload Neovim config | +| `q` | Quit current window | +| `Q` | Quit all window and close Neovim | +| `w` | Save current buffer content | +| `s` | Toggle the sidebar (show project tree view) | +| `t` | Toggle tag window (show project tags in the right window) | +| `` | Toggle spell checking | +| `` | Toggle paste mode | # Trouble shooting @@ -63,3 +65,6 @@ If you still have an issue, you may [open a new issue](https://github.com/jdhao/ + [Config nvim on Linux for Python development](https://jdhao.github.io/2018/12/24/centos_nvim_install_use_guide_en/) + [Nvim config on Windows 10](https://jdhao.github.io/2018/11/15/neovim_configuration_windows/) + [Nvim-qt config on Windows 10](https://jdhao.github.io/2019/01/17/nvim_qt_settings_on_windows/) + +[^1]: Not enabled by default for Linux, see [this issue](https://github.com/jdhao/nvim-config/issues/4#issuecomment-617736636) on +How to enable vimtex on Linux.