| 1 | # {{PascalName}} Pane
|
| 2 |
|
| 3 | {{name}} does a thing. It's intended to be a part of something flow. Describe step below in the next section.
|
| 4 |
|
| 5 | ## Usage
|
| 6 | ```js
|
| 7 | var {{PascalName}} = require('{{name}}')
|
| 8 | , options = {}
|
| 9 | , {{camelName}} = new {{PascalName}}(options)
|
| 10 | ```
|
| 11 |
|
| 12 | ```css
|
| 13 | @import "{{name}}";
|
| 14 | ```
|
| 15 |
|
| 16 | ## JS Options
|
| 17 | ### `<String> option` **Required**
|
| 18 | Defaults to "hi". Controls X.
|
| 19 |
|
| 20 | ## JS Methods
|
| 21 | ### `doesThings(<Number> arg)`
|
| 22 | Does X. Arg is used for Y. Returns Z.
|
| 23 |
|
| 24 | ## JS Events
|
| 25 | ### eventName `(<Number> arg)`
|
| 26 | Emitted when Z happens. `arg` is a Y.
|
| 27 |
|
| 28 | ======
|
| 29 |
|
| 30 | # {{PascalName}} Step
|
| 31 |
|
| 32 | {{name}} does a thing. It's intended to be a part of something flow.
|
| 33 |
|
| 34 | ## JS Options
|
| 35 | ### `<String> option` **Required**
|
| 36 | Defaults to "hi". Controls X.
|
| 37 |
|
| 38 | ## JS Methods
|
| 39 | ### `doesThings(<Number> arg)`
|
| 40 | Does X. Arg is used for Y. Returns Z.
|
| 41 |
|
| 42 | ## JS Events
|
| 43 | ### eventName `(<Number> arg)`
|
| 44 | Emitted when Z happens. `arg` is a Y.
|
| 45 |
|
| 46 | ## Tests
|
| 47 | Tests are in [tape](https://github.com/substack/tape). You can run them with:
|
| 48 |
|
| 49 | ```bash
|
| 50 | browserify -t hbsfy --debug | smokestack
|
| 51 | ```
|
| 52 | ## Developing
|
| 53 | Install [ribcage](https://github.com/Techwraith/ribcage)
|
| 54 |
|
| 55 | ```sh
|
| 56 | npm i -g ribcage
|
| 57 | ribcage preview .
|
| 58 | ```
|
| 59 |
|
| 60 | Open [http://localhost:4000/default](http://localhost:4000/default)
|
| 61 |
|