diff --git a/README.md b/README.md index a52f66e..acaeb3d 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ Run `ng generate component component-name` to generate a new component. You can Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. +## Documentation + +Run `npm run doc` to generate the documentation. The documentation will be stored in the `documentation/` directory. + ## Running unit tests Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). diff --git a/package.json b/package.json index 217b674..d193fb8 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,8 @@ "build": "ng build", "build:prod": "ng build --configuration production", "watch": "ng build --watch --configuration development", - "test": "ng test" + "test": "ng test", + "doc": "npx compodoc -p tsconfig.doc.json" }, "private": true, "dependencies": { diff --git a/tsconfig.doc.json b/tsconfig.doc.json new file mode 100644 index 0000000..a910fa1 --- /dev/null +++ b/tsconfig.doc.json @@ -0,0 +1,4 @@ +{ + "include": ["src/**/*.ts"], + "exclude": ["src/test.ts", "src/**/*.spec.ts", "src/app/file-to-exclude.ts"] +} \ No newline at end of file