@boundstate/tier-one-dgeni

Docs generator for Angular frameworks.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@boundstate/tier-one-dgeni
Minified + gzip package size for @boundstate/tier-one-dgeni in KB

Readme

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 containing package.json. Also used in combination with repository URL to determine source code URLs.
  • srcDir: (optional) path to source code containing index.ts (relative to baseDir)
  • faviconPath: (optional) path to favicon to be used by docs app (relative to baseDir)
  • scssPath: path to SCSS file to be used by docs app (relative to baseDir)

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);
  }
}

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.