@boundstate/tier-one-dgeni
Docs generator for Angular frameworks.
Last updated a year ago by guiltyspark .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @boundstate/tier-one-dgeni 
SYNC missed versions from official npm registry.

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

Current Tags

  • 1.1.0                                ...           latest (a year ago)

21 Versions

  • 1.1.0                                ...           a year ago
  • 1.0.0                                ...           a year ago
  • 1.0.0-alpha.2                                ...           a year ago
  • 1.0.0-alpha.1                                ...           a year ago
  • 1.0.0-alpha.0                                ...           a year ago
  • 0.5.3                                ...           a year ago
  • 0.5.2                                ...           a year ago
  • 0.5.1                                ...           a year ago
  • 0.5.0                                ...           a year ago
  • 0.4.1                                ...           2 years ago
  • 0.4.0                                ...           2 years ago
  • 0.1.4                                ...           2 years ago
  • 0.1.3-upgraded-angular                                ...           2 years ago
  • 0.3.0                                ...           2 years ago
  • 0.2.0                                ...           2 years ago
  • 0.1.3                                ...           2 years ago
  • 0.1.2                                ...           2 years ago
  • 0.1.1                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
  • 0.0.13                                ...           2 years ago
  • 0.0.12                                ...           2 years ago
Downloads
Today 0
This Week 0
This Month 2
Last Day 0
Last Week 1
Last Month 2
Dependencies (30)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |