readme markdown linting
This commit is contained in:
Tingfeng
parent
38ef7c8f61
commit
23f3997392
1 changed files with 229 additions and 156 deletions
113
README.md
113
README.md
|
|
@ -11,21 +11,27 @@ There are two versions:
|
|||
|
||||
I would, of course, recommend using the awesome version.
|
||||
|
||||
|
||||
## How to install the Awesome version?
|
||||
|
||||
### Install for your own user only
|
||||
|
||||
The awesome version includes a lot of great plugins, configurations and color schemes that make Vim a lot better. To install it simply do following from your terminal:
|
||||
|
||||
```sh
|
||||
git clone --depth=1 https://github.com/amix/vimrc.git ~/.vim_runtime
|
||||
sh ~/.vim_runtime/install_awesome_vimrc.sh
|
||||
```
|
||||
|
||||
### Install for multiple users
|
||||
|
||||
To install for multiple users, the repository needs to be cloned to a location accessible for all the intended users.
|
||||
|
||||
```sh
|
||||
git clone --depth=1 https://github.com/amix/vimrc.git /opt/vim_runtime
|
||||
sh ~/.vim_runtime/install_awesome_parameterized.sh /opt/vim_runtime user0 user1 user2
|
||||
# to install for all users with home directories
|
||||
sh ~/.vim_runtime/install_awesome_parameterized.sh /opt/vim_runtime --all
|
||||
```
|
||||
|
||||
Naturally, `/opt/vim_runtime` can be any directory, as long as all the users specified have read access.
|
||||
|
||||
|
|
@ -44,33 +50,36 @@ The basic version is just one file and no plugins. Just copy [basic.vim](https:/
|
|||
|
||||
The basic version is useful to install on remote servers where you don't need many plugins, and you don't do many edits.
|
||||
|
||||
```sh
|
||||
git clone --depth=1 https://github.com/amix/vimrc.git ~/.vim_runtime
|
||||
sh ~/.vim_runtime/install_basic_vimrc.sh
|
||||
|
||||
```
|
||||
|
||||
## How to install on Windows?
|
||||
|
||||
Use [gitforwindows](http://gitforwindows.org/) to checkout the repository and run the installation instructions above. No special instructions needed ;-)
|
||||
|
||||
|
||||
## How to install on Linux
|
||||
|
||||
If you have vim aliased as `vi` instead of `vim`, make sure to either alias it: `alias vi=vim`. Otherwise, `apt-get install vim`
|
||||
|
||||
|
||||
## How to update to latest version?
|
||||
|
||||
Just do a git rebase!
|
||||
|
||||
```sh
|
||||
cd ~/.vim_runtime
|
||||
git reset --hard
|
||||
git clean -d --force
|
||||
git pull --rebase
|
||||
python update_plugins.py # use python3 if python is unavailable
|
||||
```
|
||||
|
||||
NOTE: If you get `ModuleNotFoundError: No module named 'requests'`, you must first install the `requests` python module using `pip`, `pip3`, or `easy_install`.
|
||||
|
||||
```sh
|
||||
pip install requests
|
||||
```
|
||||
|
||||
## Some screenshots
|
||||
|
||||
|
|
@ -84,7 +93,6 @@ Colors when editing a Python file:
|
|||
Distraction free mode using [goyo.vim](https://github.com/junegunn/goyo.vim) and [vim-zenroom2](https://github.com/amix/vim-zenroom2):
|
||||
|
||||
|
||||
|
||||
## Included Plugins
|
||||
|
||||
I recommend reading the docs of these plugins to understand them better. Each plugin provides a much better Vim experience!
|
||||
|
|
@ -110,7 +118,6 @@ I recommend reading the docs of these plugins to understand them better. Each pl
|
|||
* [vim-indent-guides](https://github.com/nathanaelkane/vim-indent-guides) Is a plugin for visually displaying indent levels in Vim
|
||||
* [editorconfig-vim](https://github.com/editorconfig/editorconfig-vim) EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs.
|
||||
|
||||
|
||||
## Included color schemes
|
||||
|
||||
* [peaksea](https://github.com/vim-scripts/peaksea): The default
|
||||
|
|
@ -120,7 +127,6 @@ I recommend reading the docs of these plugins to understand them better. Each pl
|
|||
* [mayansmoke](https://github.com/vim-scripts/mayansmoke)
|
||||
* [vim-pyte](https://github.com/therubymug/vim-pyte)
|
||||
|
||||
|
||||
## Included modes
|
||||
|
||||
* [vim-coffee-script](https://github.com/kchmck/vim-coffee-script)
|
||||
|
|
@ -134,19 +140,22 @@ I recommend reading the docs of these plugins to understand them better. Each pl
|
|||
* [vim-javascript](https://github.com/pangloss/vim-javascript)
|
||||
* [vim-python-pep8-indent](https://github.com/Vimjas/vim-python-pep8-indent)
|
||||
|
||||
|
||||
## How to include your own stuff?
|
||||
|
||||
After you have installed the setup, you can create **~/.vim_runtime/my_configs.vim** to fill in any configurations that are important for you. For instance, my **my_configs.vim** looks like this:
|
||||
|
||||
```sh
|
||||
~/.vim_runtime (master)> cat my_configs.vim
|
||||
map <leader>ct :cd ~/Desktop/Todoist/todoist<cr>
|
||||
map <leader>cw :cd ~/Desktop/Wedoist/wedoist<cr>
|
||||
```
|
||||
|
||||
You can also install your plugins, for instance, via pathogen you can install [vim-rails](https://github.com/tpope/vim-rails):
|
||||
|
||||
```sh
|
||||
cd ~/.vim_runtime
|
||||
git clone git://github.com/tpope/vim-rails.git my_plugins/vim-rails
|
||||
```
|
||||
|
||||
You can also install plugins without any plugin manager (vim 8+ required):
|
||||
Add `packloadall` to your .vimrc file
|
||||
|
|
@ -155,45 +164,54 @@ You can also install plugins without any plugin manager (vim 8+ required):
|
|||
Clone the plugin that you want in that directory, for example:
|
||||
`git clone --depth=1 git://github.com/maxmellon/vim-jsx-pretty ~/.vim/pack/plugins/vim-jsx-pretty`
|
||||
|
||||
|
||||
## Key Mappings
|
||||
|
||||
The [leader](http://learnvimscriptthehardway.stevelosh.com/chapters/06.html#leader) is `,`, so whenever you see `<leader>` it means `,`.
|
||||
|
||||
|
||||
### Normal mode mappings
|
||||
|
||||
Fast saving of a buffer (`<leader>w`):
|
||||
|
||||
```vim
|
||||
nmap <leader>w :w!<cr>
|
||||
```
|
||||
|
||||
Map `<Space>` to `/` (search) and `<Ctrl>+<Space>` to `?` (backwards search):
|
||||
|
||||
```vim
|
||||
map <space> /
|
||||
map <C-space> ?
|
||||
map <silent> <leader><cr> :noh<cr>
|
||||
```
|
||||
|
||||
Disable highlights when you press `<leader><cr>`:
|
||||
|
||||
```vim
|
||||
map <silent> <leader><cr> :noh<cr>
|
||||
```
|
||||
|
||||
Smart way to move between windows (`<ctrl>j` etc.):
|
||||
|
||||
```vim
|
||||
map <C-j> <C-W>j
|
||||
map <C-k> <C-W>k
|
||||
map <C-h> <C-W>h
|
||||
map <C-l> <C-W>l
|
||||
```
|
||||
|
||||
Closing of the current buffer(s) (`<leader>bd` and (`<leader>ba`)):
|
||||
|
||||
```vim
|
||||
" Close current buffer
|
||||
map <leader>bd :Bclose<cr>
|
||||
|
||||
" Close all buffers
|
||||
map <leader>ba :1,1000 bd!<cr>
|
||||
```
|
||||
|
||||
Useful mappings for managing tabs:
|
||||
|
||||
```vim
|
||||
map <leader>tn :tabnew<cr>
|
||||
map <leader>to :tabonly<cr>
|
||||
map <leader>tc :tabclose<cr>
|
||||
|
|
@ -202,53 +220,69 @@ Useful mappings for managing tabs:
|
|||
" Opens a new tab with the current buffer's path
|
||||
" Super useful when editing files in the same directory
|
||||
map <leader>te :tabedit <C-r>=expand("%:p:h")<cr>/
|
||||
```
|
||||
|
||||
Switch [CWD](http://vim.wikia.com/wiki/Set_working_directory_to_the_current_file) to the directory of the open buffer:
|
||||
|
||||
```vim
|
||||
map <leader>cd :cd %:p:h<cr>:pwd<cr>
|
||||
```
|
||||
|
||||
Open `ack.vim` for fast search:
|
||||
|
||||
```vim
|
||||
map <leader>g :Ack
|
||||
```
|
||||
|
||||
Quickly open a buffer for scripbble:
|
||||
|
||||
```vim
|
||||
map <leader>q :e ~/buffer<cr>
|
||||
```
|
||||
|
||||
Toggle paste mode on and off:
|
||||
|
||||
```vim
|
||||
map <leader>pp :setlocal paste!<cr>
|
||||
|
||||
```
|
||||
|
||||
### Visual mode mappings
|
||||
|
||||
Visual mode pressing `*` or `#` searches for the current selection:
|
||||
|
||||
```vim
|
||||
vnoremap <silent> * :call VisualSelection('f')<CR>
|
||||
vnoremap <silent> # :call VisualSelection('b')<CR>
|
||||
```
|
||||
|
||||
When you press gv you `Ack.vim` after the selected text:
|
||||
|
||||
```vim
|
||||
vnoremap <silent> gv :call VisualSelection('gv', '')<CR>
|
||||
```
|
||||
|
||||
When you press `<leader>r` you can search and replace the selected text:
|
||||
|
||||
```vim
|
||||
vnoremap <silent> <leader>r :call VisualSelection('replace')<CR>
|
||||
```
|
||||
|
||||
Surround the visual selection in parenthesis/brackets/etc.:
|
||||
|
||||
```vim
|
||||
vnoremap $1 <esc>`>a)<esc>`<i(<esc>
|
||||
vnoremap $2 <esc>`>a]<esc>`<i[<esc>
|
||||
vnoremap $3 <esc>`>a}<esc>`<i{<esc>
|
||||
vnoremap $$ <esc>`>a"<esc>`<i"<esc>
|
||||
vnoremap $q <esc>`>a'<esc>`<i'<esc>
|
||||
vnoremap $e <esc>`>a`<esc>`<i`<esc>
|
||||
|
||||
```
|
||||
|
||||
### Insert mode mappings
|
||||
|
||||
Quickly insert parenthesis/brackets/etc.:
|
||||
|
||||
```vim
|
||||
inoremap $1 ()<esc>i
|
||||
inoremap $2 []<esc>i
|
||||
inoremap $3 {}<esc>i
|
||||
|
|
@ -256,40 +290,50 @@ Quickly insert parenthesis/brackets/etc.:
|
|||
inoremap $q ''<esc>i
|
||||
inoremap $e ""<esc>i
|
||||
inoremap $t <><esc>i
|
||||
```
|
||||
|
||||
Insert the current date and time (useful for timestamps):
|
||||
|
||||
```vim
|
||||
iab xdate <C-r>=strftime("%d/%m/%y %H:%M:%S")<cr>
|
||||
|
||||
```
|
||||
|
||||
### Command line mappings
|
||||
|
||||
$q is super useful when browsing on the command line. It deletes everything until the last slash:
|
||||
|
||||
```vim
|
||||
cno $q <C-\>eDeleteTillSlash()<cr>
|
||||
```
|
||||
|
||||
Bash like keys for the command line:
|
||||
|
||||
```vim
|
||||
cnoremap <C-A> <Home>
|
||||
cnoremap <C-E> <End>
|
||||
cnoremap <C-K> <C-U>
|
||||
|
||||
cnoremap <C-P> <Up>
|
||||
cnoremap <C-N> <Down>
|
||||
```
|
||||
|
||||
Write the file as sudo (works only on Unix). Super useful when you open a file and you don't have permissions to save your changes. [Vim tip](http://vim.wikia.com/wiki/Su-write):
|
||||
|
||||
```vim
|
||||
:W
|
||||
|
||||
```
|
||||
|
||||
### Plugin related mappings
|
||||
|
||||
Open [bufexplorer](https://github.com/vim-scripts/bufexplorer.zip) to see and manage the current buffers (`<leader>o`):
|
||||
|
||||
```vim
|
||||
map <leader>o :BufExplorer<cr>
|
||||
```
|
||||
|
||||
Open [ctrlp.vim](https://github.com/kien/ctrlp.vim) plugin to quickly find a file or a buffer (`<leader>j` or `<ctrl>f`):
|
||||
|
||||
```vim
|
||||
" Quickly find and open a file in the CWD
|
||||
let g:ctrlp_map = '<C-f>'
|
||||
|
||||
|
|
@ -298,19 +342,25 @@ Open [ctrlp.vim](https://github.com/kien/ctrlp.vim) plugin to quickly find a fil
|
|||
|
||||
" Quickly find and open a buffer
|
||||
map <leader>b :CtrlPBuffer<cr>
|
||||
```
|
||||
|
||||
[NERD Tree](https://github.com/preservim/nerdtree) mappings:
|
||||
|
||||
```vim
|
||||
map <leader>nn :NERDTreeToggle<cr>
|
||||
map <leader>nb :NERDTreeFromBookmark
|
||||
map <leader>nf :NERDTreeFind<cr>
|
||||
```
|
||||
|
||||
[goyo.vim](https://github.com/junegunn/goyo.vim) and [vim-zenroom2](https://github.com/amix/vim-zenroom2) lets you only focus on one thing at a time. It removes all the distractions and centers the content. It has a special look when editing Markdown, reStructuredText and textfiles. It only has one mapping. (`<leader>z`)
|
||||
|
||||
```vim
|
||||
map <leader>z :Goyo<cr>
|
||||
```
|
||||
|
||||
[vim-multiple-cursors](https://github.com/terryma/vim-multiple-cursors) mappings to manage multiple cursors at once:
|
||||
|
||||
```vim
|
||||
let g:multi_cursor_start_word_key = '<C-s>'
|
||||
let g:multi_cursor_select_all_word_key = '<A-s>'
|
||||
let g:multi_cursor_start_key = 'g<C-s>'
|
||||
|
|
@ -319,66 +369,88 @@ Open [ctrlp.vim](https://github.com/kien/ctrlp.vim) plugin to quickly find a fil
|
|||
let g:multi_cursor_prev_key = '<C-p>'
|
||||
let g:multi_cursor_skip_key = '<C-x>'
|
||||
let g:multi_cursor_quit_key = '<Esc>'
|
||||
```
|
||||
|
||||
[vim-yankstack](https://github.com/maxbrunsfeld/vim-yankstack) mappings to manage the kill-ring (clipboard):
|
||||
|
||||
```vim
|
||||
nmap <C-p> <Plug>yankstack_substitute_older_paste
|
||||
nmap <C-n> <Plug>yankstack_substitute_newer_paste
|
||||
```
|
||||
|
||||
[ctrl-p](https://github.com/ctrlpvim/ctrlp.vim) mappings to easily find and open a file, buffer, etc.:
|
||||
|
||||
```vim
|
||||
let g:ctrlp_map = '<C-f>'
|
||||
map <leader>j :CtrlP<cr>
|
||||
map <C-b> :CtrlPBuffer<cr>
|
||||
```
|
||||
|
||||
[vim-snipmate](https://github.com/garbas/vim-snipmate) mappings to autocomplete via snippets:
|
||||
|
||||
```vim
|
||||
ino <C-j> <C-r>=snipMate#TriggerSnippet()<cr>
|
||||
snor <C-j> <esc>i<right><C-r>=snipMate#TriggerSnippet()<cr>
|
||||
```
|
||||
|
||||
[vim-surround](https://github.com/tpope/vim-surround) mappings to easily surround a string with `_()` gettext annotation:
|
||||
|
||||
```vim
|
||||
vmap Si S(i_<esc>f)
|
||||
au FileType mako vmap Si S"i${ _(<esc>2f"a) }<esc>
|
||||
```
|
||||
|
||||
[ale](https://github.com/dense-analysis/ale) to easily go to the next Ale syntax/lint error:
|
||||
|
||||
```vim
|
||||
nmap <silent> <leader>a <Plug>(ale_next_wrap)
|
||||
```
|
||||
|
||||
[vim-indent-guides](https://github.com/nathanaelkane/vim-indent-guides) the default mapping to toggle the plugin is (`<leader>ig`)
|
||||
|
||||
You can also use the following commands inside Vim:
|
||||
```vim
|
||||
" You can also use the following commands inside Vim:
|
||||
:IndentGuidesEnable
|
||||
:IndentGuidesDisable
|
||||
:IndentGuidesToggle
|
||||
```
|
||||
|
||||
[vim-fugitive](https://github.com/tpope/vim-fugitive) to copy the link to the line of a Git repository to the clipboard:
|
||||
|
||||
```vim
|
||||
nnoremap <leader>v :.GBrowse!<CR>
|
||||
xnoremap <leader>v :'<'>GBrowse!<CR>
|
||||
|
||||
```
|
||||
|
||||
### Spell checking
|
||||
|
||||
Pressing `<leader>ss` will toggle spell checking:
|
||||
|
||||
```vim
|
||||
map <leader>ss :setlocal spell!<cr>
|
||||
```
|
||||
|
||||
Shortcuts using `<leader>` instead of special characters:
|
||||
|
||||
```vim
|
||||
map <leader>sn ]s
|
||||
map <leader>sp [s
|
||||
map <leader>sa zg
|
||||
map <leader>s? z=
|
||||
```
|
||||
|
||||
### Running Code
|
||||
|
||||
To run code directly from vim, press `F5`. The currently open code will execute without you having to type anything.
|
||||
|
||||
Can be used to execute code written in C, C++, Java, Python, Go, Octave, Bash scripts and HTML. To edit how you want your code to be executed, make changes in the file
|
||||
```
|
||||
|
||||
```sh
|
||||
~/.vim_runtime/vimrcs/extended.vim
|
||||
```
|
||||
|
||||
### Cope
|
||||
|
||||
Query `:help cope` if you are unsure what cope is. It's super useful!
|
||||
|
||||
When you search with `Ack.vim`, display your results in cope by doing:
|
||||
|
|
@ -392,21 +464,22 @@ To go to the previous search results do:
|
|||
|
||||
Cope mappings:
|
||||
|
||||
```vim
|
||||
map <leader>cc :botright cope<cr>
|
||||
map <leader>co ggVGy:tabnew<cr>:set syntax=qf<cr>pgg
|
||||
map <leader>n :cn<cr>
|
||||
map <leader>p :cp<cr>
|
||||
|
||||
```
|
||||
|
||||
## How to uninstall
|
||||
|
||||
Just do following:
|
||||
|
||||
* Remove `~/.vim_runtime`
|
||||
* Remove any lines that reference `.vim_runtime` in your `~/.vimrc`
|
||||
|
||||
|
||||
## Looking for a remote-first job?
|
||||
|
||||
Maintaining this Vim configuration isn't my day job. Daily I am the founder/CEO of [Doist](https://doist.com/). You could come and help us build the workplace of the future while living a balanced life (anywhere in the world 🌍🌎🌏).
|
||||
|
||||
PS: Using Vim isn't a requirement 😄
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue