Skip to content

Commit 86fb76f

Browse files
committed
generate docs
1 parent 0579826 commit 86fb76f

File tree

2 files changed

+19
-23
lines changed

2 files changed

+19
-23
lines changed

.verb.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
## Usage
22

33
```js
4-
var askInclude = require('{%= name %}');
5-
64
var templates = require('templates');
75
var questions = require('base-questions');
86
var app = templates();
9-
app.use(questions());
107

8+
app.use(questions());
119
app.engine('md', require('engine-base'));
12-
app.asyncHelper('askInclude', require('./')(app));
10+
app.asyncHelper('askInclude', require('{%= name %}'));
1311

1412
app.create('pages');
1513
app.create('includes');
@@ -18,11 +16,11 @@ app.include('a.md', {content: 'this is AAA'});
1816
app.include('b.md', {content: 'this is BBB'});
1917
app.include('c.md', {content: 'this is CCC'});
2018

21-
var index = app.page('index.md', {
19+
var page = app.page('index.md', {
2220
content: 'Before\n<%= askInclude("includes") %>\nAfter'
2321
});
2422

25-
app.render(index, function(err, res) {
23+
app.render(page, function(err, res) {
2624
if (err) return console.log(err);
2725
console.log(res.content);
2826
});

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# helper-ask-include [![NPM version](https://img.shields.io/npm/v/helper-ask-include.svg?style=flat)](https://www.npmjs.com/package/helper-ask-include) [![NPM downloads](https://img.shields.io/npm/dm/helper-ask-include.svg?style=flat)](https://npmjs.org/package/helper-ask-include)
1+
# helper-ask-include [![NPM version](https://img.shields.io/npm/v/helper-ask-include.svg?style=flat)](https://www.npmjs.com/package/helper-ask-include) [![NPM monthly downloads](https://img.shields.io/npm/dm/helper-ask-include.svg?style=flat)](https://npmjs.org/package/helper-ask-include) [![NPM total downloads](https://img.shields.io/npm/dt/helper-ask-include.svg?style=flat)](https://npmjs.org/package/helper-ask-include)
22

3-
Async template helper that prompts the user to choose the include or includes to render.
3+
> Async template helper that prompts the user to choose the `include` or `includes` to render.
44
55
## Install
66

@@ -13,15 +13,13 @@ $ npm install --save helper-ask-include
1313
## Usage
1414

1515
```js
16-
var askInclude = require('helper-ask-include');
17-
1816
var templates = require('templates');
1917
var questions = require('base-questions');
2018
var app = templates();
21-
app.use(questions());
2219

20+
app.use(questions());
2321
app.engine('md', require('engine-base'));
24-
app.asyncHelper('askInclude', require('./')(app));
22+
app.asyncHelper('askInclude', require('helper-ask-include'));
2523

2624
app.create('pages');
2725
app.create('includes');
@@ -30,11 +28,11 @@ app.include('a.md', {content: 'this is AAA'});
3028
app.include('b.md', {content: 'this is BBB'});
3129
app.include('c.md', {content: 'this is CCC'});
3230

33-
var index = app.page('index.md', {
31+
var page = app.page('index.md', {
3432
content: 'Before\n<%= askInclude("includes") %>\nAfter'
3533
});
3634

37-
app.render(index, function(err, res) {
35+
app.render(page, function(err, res) {
3836
if (err) return console.log(err);
3937
console.log(res.content);
4038
});
@@ -48,34 +46,34 @@ Pull requests and stars are always welcome. For bugs and feature requests, [plea
4846

4947
### Building docs
5048

51-
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
49+
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
5250

53-
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
51+
To generate the readme, run the following command:
5452

5553
```sh
56-
$ npm install -g verb verb-generate-readme && verb
54+
$ npm install -g verbose/verb#dev verb-generate-readme && verb
5755
```
5856

5957
### Running tests
6058

61-
Install dev dependencies:
59+
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
6260

6361
```sh
64-
$ npm install -d && npm test
62+
$ npm install && npm test
6563
```
6664

6765
### Author
6866

6967
**Jon Schlinkert**
7068

7169
* [github/jonschlinkert](https://github.com/jonschlinkert)
72-
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
70+
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
7371

7472
### License
7573

76-
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
77-
Released under the [MIT license](https://github.com/helpers/helper-ask-include/blob/master/LICENSE).
74+
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
75+
MIT
7876

7977
***
8078

81-
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 27, 2016._
79+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 20, 2017._

0 commit comments

Comments
 (0)