hasufell
/
neosnippet.vim
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix #428 update the documentation

This commit is contained in:
Shougo Matsushita 2018-05-01 20:40:19 +09:00
parent 8cf286e3bf
commit fa7cc15aee
2 changed files with 44 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@ -5,11 +5,9 @@ The Neosnippet plug-In adds snippet support to Vim. Snippets are
small templates for commonly used code that you can fill in on the small templates for commonly used code that you can fill in on the
fly. To use snippets can increase your productivity in Vim a lot. fly. To use snippets can increase your productivity in Vim a lot.
The functionality of this plug-in is quite similar to plug-ins like The functionality of this plug-in is quite similar to plug-ins like
snipMate.vim or snippetsEmu.vim. But since you can choose snippets with the snipMate.vim. But since you can choose snippets with the
[neocomplcache](https://github.com/Shougo/neocomplcache.vim) / [deoplete](https://github.com/Shougo/deoplete.nvim) interface, you might have
[neocomplete](https://github.com/Shougo/neocomplete.vim) interface, you might less trouble using them, because you do not have to remember each snippet name.
have less trouble using them, because you do not have to remember each snippet
name.
Installation Installation
------------ ------------
@ -22,84 +20,73 @@ Notes:
* Vim 7.4 or above is needed. * Vim 7.4 or above is needed.
* Vim 8.0 or above or neovim is recommended.
* Default snippets files are available in: * Default snippets files are available in:
[neosnippet-snippets](https://github.com/Shougo/neosnippet-snippets) [neosnippet-snippets](https://github.com/Shougo/neosnippet-snippets)
* Installing default snippets is optional. If choose not to install them, * Installing default snippets is optional. If choose not to install them,
you must deactivate them with `g:neosnippet#disable_runtime_snippets`. you must deactivate them with `g:neosnippet#disable_runtime_snippets`.
* neocomplcache/neocomplete is not required to use neosnippet, but it's highly recommended.
* deoplete is not required to use neosnippet, but it's highly recommended.
* Extra snippets files can be found in: * Extra snippets files can be found in:
[vim-snippets](https://github.com/honza/vim-snippets). [vim-snippets](https://github.com/honza/vim-snippets).
### Manual (not recommended)
1. Install the
[neocomplcache](https://github.com/Shougo/neocomplcache.vim)/
[neocomplete](https://github.com/Shougo/neocomplete.vim) and
[neosnippet-snippets](https://github.com/Shougo/neosnippet-snippets)
first.
2. Put files in your Vim directory (usually `~/.vim/` or
`%PROGRAMFILES%/Vim/vimfiles` on Windows).
### Vundle ### Vundle
1. Setup the [vundle](https://github.com/gmarik/vundle) package manager
2. Set the bundles for [neocomplcache](https://github.com/Shougo/neocomplcache)
or [neocomplete](https://github.com/Shougo/neocomplete.vim)
And [neosnippet](https://github.com/Shougo/neosnippet)
And [neosnippet-snippets](https://github.com/Shougo/neosnippet-snippets)
```vim ```vim
Plugin 'Shougo/neocomplcache' Plugin 'Shougo/deoplete.nvim'
or if !has('nvim')
Plugin 'Shougo/neocomplete' Plugin 'roxma/nvim-yarp'
Plugin 'roxma/vim-hug-neovim-rpc'
endif
Plugin 'Shougo/neosnippet' Plugin 'Shougo/neosnippet.vim'
Plugin 'Shougo/neosnippet-snippets' Plugin 'Shougo/neosnippet-snippets'
``` ```
3. Open up Vim and start installation with `:PluginInstall` ### dein.vim
### Neobundle
1. Setup the [neobundle](https://github.com/Shougo/neobundle.vim) package manager
2. Set the bundles for [neocomplcache](https://github.com/Shougo/neocomplcache)
or [neocomplete](https://github.com/Shougo/neocomplete.vim)
And [neosnippet](https://github.com/Shougo/neosnippet)
And [neosnippet-snippets](https://github.com/Shougo/neosnippet-snippets)
```vim ```vim
NeoBundle 'Shougo/neocomplcache' call dein#add('Shougo/deoplete.nvim')
or if !has('nvim')
NeoBundle 'Shougo/neocomplete' call dein#add('roxma/nvim-yarp')
call dein#add('roxma/vim-hug-neovim-rpc')
endif
let g:deoplete#enable_at_startup = 1
NeoBundle 'Shougo/neosnippet' call dein#add('Shougo/neosnippet.vim')
NeoBundle 'Shougo/neosnippet-snippets' call dein#add('Shougo/neosnippet-snippets')
``` ```
3. Open up Vim and start installation with `:NeoBundleInstall` ### vim-plug
### VAM (vim-addon-manager)
1. Setup the [vim-addon-manager](https://github.com/MarcWeber/vim-addon-manager)
package manager.
2. Add `neosnippet` to the list of addons in your vimrc:
```vim ```vim
call vam#ActivateAddons(['neosnippet', 'neosnippet-snippets']) if has('nvim')
``` Plug 'Shougo/deoplete.nvim', { 'do': ':UpdateRemotePlugins' }
else
Plug 'Shougo/deoplete.nvim'
Plug 'roxma/nvim-yarp'
Plug 'roxma/vim-hug-neovim-rpc'
endif
let g:deoplete#enable_at_startup = 1
. Installation will start automatically when you open vim next time. Plug 'Shougo/neosnippet.vim'
Plug 'Shougo/neosnippet-snippets'
```
Configuration Configuration
------------- -------------
This is an example `~/.vimrc` configuration for Neosnippet. It is assumed you This is an example `~/.vimrc` configuration for Neosnippet. It is assumed you
already have Neocomplcache configured. With the settings of the example, you already have deoplete configured. With the settings of the example, you can use
can use the following keys: the following keys:
* `C-k` to select-and-expand a snippet from the Neocomplcache popup (Use `C-n` * `C-k` to select-and-expand a snippet from the deoplete popup (Use `C-n`
and `C-p` to select it). `C-k` can also be used to jump to the next field in and `C-p` to select it). `C-k` can also be used to jump to the next field in
the snippet. the snippet.
* `Tab` to select the next field to fill in the snippet. * `Tab` to select the next field to fill in the snippet.
```vim ```vim

11
doc/neosnippet.txt
View File

@ -23,9 +23,8 @@ INTRODUCTION *neosnippet-introduction*
*neosnippet* offers functionality similar to snipMate.vim or snippetsEmu.vim. *neosnippet* offers functionality similar to snipMate.vim or snippetsEmu.vim.
This analyzes snippet files which you can use for the completion. Since you This analyzes snippet files which you can use for the completion. Since you
can choose snippets with the neocomplcache/neocomplete interface, you might can choose snippets with the deoplete interface, you might have less trouble
have less trouble using them, because you do not have to remember each snippet using them, because you do not have to remember each snippet name.
name.
============================================================================== ==============================================================================
INSTALL *neosnippet-install* INSTALL *neosnippet-install*
@ -33,9 +32,8 @@ INSTALL *neosnippet-install*
1: Extract the file and put files in your Vim directory 1: Extract the file and put files in your Vim directory
(usually ~/.vim/ or Program Files/Vim/vimfiles on Windows). (usually ~/.vim/ or Program Files/Vim/vimfiles on Windows).
Note: If you want to complete snippets, you must install either neocomplcache Note: If you want to complete snippets, you must install deoplete
(https://github.com/Shougo/neocomplcache.vim) or neocomplete (https://github.com/Shougo/deoplete.nvim). It's not required, but highly
(https://github.com/Shougo/neocomplete.vim). It's not required, but highly
recommended. recommended.
Default snippets files are available in neosnippet-snippets. Default snippets files are available in neosnippet-snippets.
@ -56,7 +54,6 @@ current 'filetype' of the file, but also depends on the cursor location, such
as javascript inside html, or lua inside Vim scripts. as javascript inside html, or lua inside Vim scripts.
https://github.com/Shougo/context_filetype.vim https://github.com/Shougo/context_filetype.vim
==============================================================================
INTERFACE *neosnippet-interface* INTERFACE *neosnippet-interface*
------------------------------------------------------------------------------ ------------------------------------------------------------------------------