refactor: move and correct how to generate docs, fix the build:docs script in package.json and add docs folder into npmignore

Author: RSginer

README.md

@@ -107,6 +107,15 @@ This will generate a `dist` directory with:
 - `*.d.ts`: type definitions for you library
 - `sample-library.metadata.json`: metadata for your library to support AOT compilation 
 
+## Generating documentation for your library
+
+From the root of your library directory, run:
+
+```bash
+$ npm run build:docs
+```
+This will generate a `docs` directory with all documentation of your library
+
 ## Publishing your library to NPM
 
 To publish your library to NPM, first generate the `dist` directory:

generators/app/templates/README.MD

@@ -53,15 +53,6 @@ Once your library is imported, you can use its components, directives and pipes
 <sampleComponent></sampleComponent>
 ```
 
-+## Generate docs
- +
- +From the root of your library directory, run:
- +
- +```bash
- +$ npm run build:docs
- +```
- +This will generate a `docs` directory with all documentation of your library
- +
 ## Development
 
 To generate all `*.js`, `*.d.ts` and `*.metadata.json` files:

generators/app/templates/_package.json

@@ -4,7 +4,7 @@
   "scripts": {
     "build": "gulp build",
     "build:watch": "gulp",
-    "build:docs": "./node_modules/.bin/compodoc -p tsconfig.json -n <%= props.libraryName %> -d docs --hideGenerator",
+    "build:docs": "compodoc -p tsconfig.json -n <%= props.libraryName %> -d docs --hideGenerator",
     "lint": "tslint --type-check --project tsconfig.json src/**/*.ts",
     "test": "tsc && karma start"
   },

generators/app/templates/npmignore

@@ -1,7 +1,7 @@
 # Node
 node_modules/*
 npm-debug.log
-
+docs/*
 # DO NOT IGNORE TYPESCRIPT FILES FOR NPM
 # TypeScript
 # *.js