Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #91

Merged
merged 1 commit into from
Jun 20, 2020
Merged

Update README.md #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,27 @@ If you want use old version checkout [1.0.0](https://github.com/heavenshell/vim-

## Install

Since version 2.0.0, jsdoc.vim requires [lehre](https://www.npmjs.com/package/lehre).
### Vim Plug

You can install following command.
```
Plug 'heavenshell/vim-jsdoc', {
\ 'for': ['javascript', 'javascript.jsx','typescript'],
\ 'do': 'make install'
\}
```

### Manual Installation

Since version 2.0.0, jsdoc.vim requires a local copy [lehre](https://www.npmjs.com/package/lehre) installed to the plugin directory.

You can install lehre with:

```console
# cd to <vim-jsdoc path>
make install
```

If you want to update `lehre` hit following commands.
If you want to update `lehre` use:

```console
make clean
Expand All @@ -35,7 +47,7 @@ If you want install lehre manually, you can install from npm.
$ yarn add -D lehre
```

Than set installed `/path/to/node_modules/.bin/lehre` path to `g:jsdoc_lehre_path`.
Then set installed `/path/to/node_modules/.bin/lehre` path to `g:jsdoc_lehre_path`.

## Usage

Expand Down