feat: add compodoc https://mpgp.github.io/compodoc

The missing documentation tool for our Angular application

.ToDo

@@ -1,11 +1,8 @@
 mpgp.github.io:
-https://github.com/mpgp/mpgp.github.io/projects/1
+    https://github.com/mpgp/mpgp.github.io/projects/1
 
     In Progress:
-
-        @low @feature 
-        ☐ feat(compodoc): install package https://github.com/compodoc/compodoc
-
+
         @high @refactoring 
         ☐ refactor: use css BEM-selectors @created(18-06-12 21:35:58)
 

package.json

@@ -1,6 +1,6 @@
 {
   "version": "1.0.0",
-  "name": "spec",
+  "name": "mpgp",
   "description": "MPGP Documentation",
   "author": "loktionov129",
   "license": "BSD-2-Clause",
@@ -87,6 +87,7 @@
     "build": "npm run clean && ng build --prod",
     "clean": "rm -rf ./dist",
     "commitmsg": "commitlint -E GIT_PARAMS",
+    "compodoc": "./node_modules/.bin/compodoc -d dist/compodoc -p tsconfig.json -n 'MPGP Documentation'",
     "lint": "ng lint",
     "ng": "ng",
     "precommit": "lint-staged",
@@ -122,6 +123,7 @@
     "@commitlint/cli": "7.0.0",
     "@commitlint/config-conventional": "7.0.1",
     "@commitlint/config-lerna-scopes": "7.0.0",
+    "@compodoc/compodoc": "1.1.3",
     "@semantic-release/changelog": "2.0.2",
     "@semantic-release/git": "5.0.0",
     "@semantic-release/github": "4.2.17",

scripts/ci/3_before_script.sh

@@ -7,6 +7,7 @@ COMMANDS_TO_RUN=()
 COMMANDS_TO_RUN+=('echo 3_before_script.sh ...')
 COMMANDS_TO_RUN+=('yarn run lint')
 COMMANDS_TO_RUN+=('yarn run build')
+COMMANDS_TO_RUN+=('yarn run compodoc')
 
 RETURN_CODES=()
 FAILURE=0

src/app/components/app-sidenav/app-sidenav.component.html

@@ -4,6 +4,7 @@
   <a mat-list-item routerLink="/spec" routerLinkActive="active" class="cursive">Spec</a>
   <mat-divider></mat-divider>
   <mat-divider></mat-divider>
+  <a mat-list-item href="/compodoc" target="_blank">Compodoc</a>
   <a mat-list-item href="https://github.com/mpgp/Documentation/wiki" target="_blank">Tech Doc</a>
   <a mat-list-item href="https://github.com/mpgp/Mpgp/blob/master/CHANGELOG.md" target="_blank">CHANGELOG</a>
   <a mat-list-item href="https://github.com/mpgp/Mpgp/blob/master/LICENSE" target="_blank">LICENCE</a>