From 5da2bed4d16db15e2b203c9b85ab668be24bb495 Mon Sep 17 00:00:00 2001 From: Jochen Saalfeld Date: Mon, 3 Sep 2018 12:05:01 +0200 Subject: [PATCH] updating the compodoc run command --- client/README.md | 3 +++ client/package.json | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/client/README.md b/client/README.md index 76bda7797..b2b771660 100644 --- a/client/README.md +++ b/client/README.md @@ -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. diff --git a/client/package.json b/client/package.json index ac9c338ee..e10b14728 100644 --- a/client/package.json +++ b/client/package.json @@ -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"