1.1.0 • Published 6 years ago
@boundstate/tier-one-dgeni v1.1.0
tier-one-dgeni
Docs generator for Angular frameworks.
Setup
$ npm install --save-dev @boundstate/tier-one-dgeni
Add .frameworkrc
or .frameworkrc.json
to your project root:
{
"srcDir": "src",
"faviconPath": "src/favicon.ico",
"scssPath": "src/scss/my-framework.scss"
}
Run docs app, watching for changes:
npx tier-one-dgeni watch
Configuration options
baseDir
: (optional) path to project root containingpackage.json
. Also used in combination with repository URL to determine source code URLs.srcDir
: (optional) path to source code containingindex.ts
(relative tobaseDir
)faviconPath
: (optional) path to favicon to be used by docs app (relative tobaseDir
)scssPath
: path to SCSS file to be used by docs app (relative tobaseDir
)
Demos
Add a demo for a component by creating a _demo
folder within the component folder. Create a file that exports a module with a name ending in DemoModule
(e.g. ButtonDemoModule
).
DemoService#setFormGroup(formGroup: FormGroup)
Renders debug information about form controls.
Usage
@import {DemoService} from '@boundstate/tier-one-dgeni';
@Component({templateUrl: 'demo.html'})
class InputTextDemoComponent {
formGroup = new FormGroup({
'text1': new FormControl(''),
'text2': new FormControl('', Validators.required)
});
constructor(demo: DemoService) {
demo.setFormGroup(this.formGroup);
}
}
1.1.0
6 years ago
1.0.0
6 years ago
1.0.0-alpha.2
6 years ago
1.0.0-alpha.1
6 years ago
1.0.0-alpha.0
6 years ago
0.5.3
6 years ago
0.5.2
6 years ago
0.5.1
6 years ago
0.5.0
6 years ago
0.4.1
6 years ago
0.4.0
6 years ago
0.1.4
7 years ago
0.1.3-upgraded-angular
7 years ago
0.3.0
7 years ago
0.2.0
7 years ago
0.1.3
7 years ago
0.1.2
7 years ago
0.1.1
7 years ago
0.1.0
7 years ago
0.0.13
7 years ago
0.0.12
7 years ago