add compodoc support #50

Author: Ks89

.circleci/config.yml

@@ -42,6 +42,9 @@ jobs:
       - run:
           name: run-docs
           command: npm run docs
+      - run:
+          name: run-compodoc
+          command: npm run compodoc
       - run:
           name: run-codeclimate
           command: npm run codeclimate

.gitignore

@@ -28,4 +28,5 @@ dist
 aot
 .awcache
 docs
+documentation
 dll

CHANGELOG.md

@@ -1,3 +1,8 @@
+#### Beta 7
+##### Features
+- add compodoc support #50
+
+
 #### Beta 6
 ##### Bugfixes
 - fix e2e tests on Windows. There are also some improvements for all other platforms

README.md

@@ -39,6 +39,7 @@ I suggest to add this repo as git remote to your repository to be able to update
     - [Codelyzer](https://github.com/mgechev/codelyzer)
 - Documentation
     - [TypeDoc](https://github.com/TypeStrong/typedoc)
+    - [Compodod](https://github.com/compodoc/compodoc)
 - Continous Integration
     - [Travis CI](https://travis-ci.org/)
     - [Circle CI](https://circleci.com/)
@@ -48,6 +49,7 @@ I suggest to add this repo as git remote to your repository to be able to update
 
 
 ## News
+- *10/06/2017* - Beta 7 - Check [HERE](https://github.com/Ks89/Angular2-webpack2-skeleton/releases)
 - *10/05/2017* - Beta 6 - Check [HERE](https://github.com/Ks89/Angular2-webpack2-skeleton/releases)
 - *09/22/2017* - Beta 5 - Check [HERE](https://github.com/Ks89/Angular2-webpack2-skeleton/releases)
 - *09/18/2017* - Beta 4 - Check [HERE](https://github.com/Ks89/Angular2-webpack2-skeleton/releases)
@@ -224,10 +226,11 @@ If you have problems with e2e testing, you should downgrade `@types/jasmine` to
 
 ## Other
 
-### To generate typescript's documentation (check docs/index.html with the result)
+### To generate typescript's documentation with typedocs (check docs/index.html for the result)
 - `npm run docs`
 
-I have to write the documentation, but this project is ready to use typedocs
+### To generate the really cool compodoc's documentation (check documentation/index.html for the result)
+- `npm run compodoc`
 
 ### To generate webpack bundle's results
 - `npm run build:dev` (or `build:prod` or `build:prod:aot`)

appveyor.yml

@@ -185,6 +185,7 @@ deploy_script:
 # on successful build
 on_success:
   - npm run docs
+  - npm run compodoc
   - codeclimate-test-reporter < coverage/lcov.info
   - node .\node_modules\coveralls\bin\coveralls.js < .\coverage\lcov.info