-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
afba932
commit df81f06
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Documentation Demo | ||
|
||
This project uses https://github.com/compodoc/compodoc in order to generate a documentation web app. | ||
Documentation of the plugin can be found at https://compodoc.app/guides/getting-started.html. | ||
--- | ||
|
||
## Setup | ||
|
||
1. run `npm install` to install the dependencies for the demo. | ||
2. run `npm start` to start local dev server with proxy. | ||
|
||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.1.1. | ||
|
||
## Generate documentation | ||
Run `npm run generate-docs` in order to run compodoc which will generate a documentation folder under dist. | ||
|
||
## Deploy documentation | ||
This step requires that `npm run generate-docs` was already run. Run `npm run deploy-docs` in order to create a new webapp and deploy it to a tenant of your liking. You can edit the cumulocity.json.doc to change metadata for the documentation webapp. You can also edit the script-command in the package.json to change the tenant endpoint. |