Skip to content

Commit 91bb90b

Browse files
committed
docs: update readme
1 parent c356bcc commit 91bb90b

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,29 @@ npm i vuepress-jsdoc -g
1919

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

25+
You can also use `npx vuepress-jsdoc`, if you want.
26+
2527
#### Plugin (Dev-Mode) `alpha`
2628

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

3032
```javascript
31-
// .vuepress/config.js
33+
// ./documentation/.vuepress/config.js
3234
plugins: [
3335
[
3436
require('vuepress-jsdoc').default,
3537
{
3638
folder: 'code',
37-
jsDocConfigPath: './jsdoc.json',
38-
source: './src',
39+
source: './dist',
3940
dist: './documentation',
40-
title: 'API'
41+
title: 'API',
42+
partials: ['./example/partials/*.hbs'],
43+
readme: './README.md',
44+
exclude: '**/*.d.ts,**/interfaces.*,**/constants.*,**/cmds.*'
4145
}
4246
]
4347
];

0 commit comments

Comments
 (0)