Skip to content

Commit

Permalink
feat: api documentation (#7)
Browse files Browse the repository at this point in the history
* feat: hidden component

* feat: create library documentation

* feat: link from demo to docs

* chore: run docs during build

* fix: location of generated docs

* fix: erroneous text in readme

* chore: updated generated doc config

Hide the coverage page
Hide the private members
Hide the Compodoc logo

* docs: stubbed in some basic docs for widget

* docs: adds docs to some components

* chore: turn off coverage for deployed docs

* chore: adds rxjs as a peerDependency

* docs: stubs in some default docs

* docs: correct typos
  • Loading branch information
jscharett authored Jul 1, 2019
1 parent 0c44ac1 commit 708160c
Show file tree
Hide file tree
Showing 19 changed files with 1,407 additions and 6 deletions.
9 changes: 9 additions & 0 deletions .compodocrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"disableLifeCycleHooks": true,
"disablePrivate": true,
"hideGenerator": true,
"name": "NGX JSOLN Schema Form",
"output": "dist/demo/documentation",
"theme": "material",
"tsconfig": "./projects/ngx-json-schema-form/tsconfig.lib.json"
}
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ script:
- npm run lint
- npm run test-ci
- npm run build
- npm run compodoc -- --disableCoverage
after_success:
- codecov
deploy:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ bring parity with [Angular JSON Schema Form](https://github.com/angular2-json-sc

### To install from NPM

```shell
```
npm install ngx-json-schema-form
```
Loading

0 comments on commit 708160c

Please sign in to comment.