Skip to content

Commit

Permalink
refactor: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ph1p committed Nov 29, 2018
1 parent 40b0125 commit d4c3bf1
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ vuepress-jsdoc --source=./src --dist=./documentation --folder=code --title=API

### Options

|name|default|description|
|-|-|-|
|--source=|./src|Source folder with .js or .ts files|
|--dist=|./documentation|Destination folder|
|--folder=|./code|Folder inside destination folder. Gets overwritten everytime|
|--title=|API|Title of your documentation|
| name | default | description |
| --------- | --------------- | ------------------------------------------------------------ |
| --source= | ./src | Source folder with .js or .ts files |
| --dist= | ./documentation | Destination folder |
| --folder= | ./code | Folder inside destination folder. Gets overwritten everytime |
| --title= | API | Title of your documentation |

### config.js

Expand Down Expand Up @@ -114,4 +114,4 @@ yarn run build

- [ ] Update description README.md
- [ ] Custom README.md
- [ ] Custom meta data
- [ ] Custom meta data

0 comments on commit d4c3bf1

Please sign in to comment.