Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ph1p committed Sep 3, 2021
1 parent c356bcc commit 91bb90b
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,29 @@ npm i vuepress-jsdoc -g

```bash
# search code in src and move it to code (./documentation/code) in your vuepress folder (./documentation)
vuepress-jsdoc --source ./src --dist ./documentation --folder code --title API --exclude=**/*/*.test.js
vuepress-jsdoc --source ./src --dist ./documentation --folder code --title API --exclude="**/*/*.test.js"
```

You can also use `npx vuepress-jsdoc`, if you want.

#### Plugin (Dev-Mode) `alpha`

You can use `vuepress-jsdoc` also as plugin.
This plugin watches you generated files.

```javascript
// .vuepress/config.js
// ./documentation/.vuepress/config.js
plugins: [
[
require('vuepress-jsdoc').default,
{
folder: 'code',
jsDocConfigPath: './jsdoc.json',
source: './src',
source: './dist',
dist: './documentation',
title: 'API'
title: 'API',
partials: ['./example/partials/*.hbs'],
readme: './README.md',
exclude: '**/*.d.ts,**/interfaces.*,**/constants.*,**/cmds.*'
}
]
];
Expand Down

0 comments on commit 91bb90b

Please sign in to comment.