Update README with optional TypeDoc information

This commit is contained in:
James Skemp 2020-07-29 00:01:20 -05:00
parent 75ecaf5269
commit d91672287b
2 changed files with 8 additions and 1 deletions

View File

@ -31,5 +31,11 @@ npm run eslint
npm run lint | grep require-returns
```
### Generate Docs
This requires that `npm install --global typedoc http-server`. See https://typedoc.org/.
```
npm run docs
```
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).

View File

@ -6,7 +6,8 @@
"serve": "vue-cli-service serve",
"build": "vue-cli-service build --modern",
"lint": "vue-cli-service lint",
"eslint": "eslint ./src --ext .js,.jsx,.ts,.tsx,.vue || (exit 0)"
"eslint": "eslint ./src --ext .js,.jsx,.ts,.tsx,.vue || (exit 0)",
"docs": "typedoc --out docs src && http-server docs"
},
"dependencies": {
"@vue/eslint-config-typescript": "^5.0.2",