@@ -14,13 +14,17 @@ Neovim works since v2.1.0, but if something wrong, send me pull requests to fix
1414
1515If you want use old version checkout [ 1.0.0] ( https://github.com/heavenshell/vim-jsdoc/releases/tag/1.0.0> ) .
1616
17+ ## Requirements
18+
19+ Node v12.x or above.
20+
1721## Install
1822
1923### Vim Plug
2024
2125```
22- Plug 'heavenshell/vim-jsdoc', {
23- \ 'for': ['javascript', 'javascript.jsx','typescript'],
26+ Plug 'heavenshell/vim-jsdoc', {
27+ \ 'for': ['javascript', 'javascript.jsx','typescript'],
2428 \ 'do': 'make install'
2529\}
2630```
@@ -94,7 +98,7 @@ Option |Default |Description
9498
9599You can choose formatter from [ JsDoc] ( https://jsdoc.app/ ) , [ ESDoc] ( https://esdoc.org/ ) , [ TSDoc] ( https://github.com/microsoft/tsdoc ) .
96100
97- If you want to create your own template, see [ example template] ( https://github.com/heavenshell/ts-lehre/tree/master/examples ) .
101+ If you want to create your own template, see [ example template] ( https://github.com/heavenshell/ts-lehre/tree/master/examples ) .
98102
99103## Interactive input
100104
@@ -107,21 +111,25 @@ See [snippet example template](./examples/snippet_template.js).
107111## Keymap
108112
109113You can add following setting to .vimrc
114+
110115``` vim
111116nmap <silent> <C-l> <Plug>(jsdoc)
112117```
113118
114119Alternatively, you could add the following setting to your .vimrc to search for the last ` function ` declaration
115120and puts your jsdoc above it:
121+
116122``` vim
117123nmap <silent> <C-l> ?function<cr>:noh<cr><Plug>(jsdoc)
118124```
119125
120126## Thanks
127+
121128- This plugin based on https://gist.github.com/3903772#file-jsdoc-vim written by [ NAKAMURA, Hisashi] ( https://gist.github.com/sunvisor )
122129
123130- The idea of npm packages installation is from [ vim-lsp-settings] ( https://github.com/mattn/vim-lsp-settings ) .
124131Highly applicate [ @mattn ] ( https://github.com/mattn/ ) and all vim-lsp-settings contributors.
125132
126133## LICENSE
134+
127135New BSD LICENSE
0 commit comments