ag-admin
/
OpenSlides
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updating the compodoc run command

This commit is contained in:
Jochen Saalfeld 2018-09-03 12:05:01 +02:00
parent c3bc1487d7
commit 5da2bed4d1
No known key found for this signature in database
GPG Key ID: 8ACD4E8264B67DF4
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
client/README.md
View File

@ -32,6 +32,9 @@ The documentation can be generated by running `npm run compodoc`.
A new web server will be started on http://localhost:8080
Once running, the documentation will be updated automatically.
You can run it on another port, with adding your local port after the
command. If no port specified, it will try to use 8080.
Please document new code using JSDoc tags.
See https://compodoc.app/guides/jsdoc-tags.html for details.

2
client/package.json
View File

@ -8,7 +8,7 @@
"test": "ng test",
"lint": "ng lint",
"e2e": "ng e2e",
"compodoc": "./node_modules/.bin/compodoc --hideGenerator -p src/tsconfig.app.json -n 'OpenSlides Documentation' -d ../Compodoc -s -w -t -o",
"compodoc": "./node_modules/.bin/compodoc --hideGenerator -p src/tsconfig.app.json -n 'OpenSlides Documentation' -d ../Compodoc -s -w -t -o --port",
"extract": "ngx-translate-extract -i ./src -o ./src/assets/i18n/{en,de,fr}.json --clean --sort --format-indentation ' ' --format namespaced-json",
"format:fix": "pretty-quick --staged",
"precommit": "run-s format:fix lint"