Angular 2+ components to create documentation on Angular Material.
- Component changeDetection is set to
OnPush, it gives better overall performance.
keyis header value, so it is possible to dynamically change table structure.
- Need to change
@Input()instance to have changes visible on template.
- Tests are not ready yet.
Table of contents
Clone this repository:
git clone https://github.com/ngx-docs/api.git
demo folder and by opening your command line do the following:
npm i && npm start
Open http://localhost:4200/ in your browser.
To install, run:
npm install @ngx-docs/api --save
In your component file:
app.component.html write the following code:
- AngularJS Git Commit Message Conventions https://gist.github.com/stephenparish/9941e89d80e2bc58a153
Semantic Versioning 2.0.0 http://semver.org/
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
How should I deal with revisions in the 0.y.z initial development phase?
The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.
How do I know when to release 1.0.0?
If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.
MIT © ngx-docs