Skip to content

Commit

Permalink
Added readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
hnaether-sag committed Jan 26, 2021
1 parent afba932 commit df81f06
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions documentation-demo/README.md
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.

0 comments on commit df81f06

Please sign in to comment.