Skip to content

Commit 47bc145

Browse files
committed
generate docs with verb
1 parent fa6f857 commit 47bc145

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
> Markdown template helper. Uses remarkable to render markdown in templates. Should work with Handlebars, Lo-Dash or any template engine that supports helper functions.
44
5+
- [Install](#install)
56
- [API](#api)
67
- [Usage examples](#usage-examples)
78
- [Register the helper](#register-the-helper)
@@ -18,6 +19,14 @@
1819

1920
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
2021

22+
## Install
23+
24+
Install with [npm](https://www.npmjs.com/):
25+
26+
```sh
27+
$ npm i helper-markdown --save
28+
```
29+
2130
## API
2231

2332
```js
@@ -152,7 +161,7 @@ _.template('<%= markdown("# heading") %>', {}, settings);
152161

153162
* [assemble](https://www.npmjs.com/package/assemble): Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… [more](https://www.npmjs.com/package/assemble) | [homepage](https://github.com/assemble/assemble)
154163
* [handlebars](https://www.npmjs.com/package/handlebars): Handlebars provides the power necessary to let you build semantic templates effectively with no frustration | [homepage](http://www.handlebarsjs.com/)
155-
* [lodash](https://www.npmjs.com/package/lodash): The modern build of lodash modular utilities. | [homepage](https://lodash.com/)
164+
* [lodash](https://www.npmjs.com/package/lodash): Lodash modular utilities. | [homepage](https://lodash.com/)
156165
* [template](https://www.npmjs.com/package/template): Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… [more](https://www.npmjs.com/package/template) | [homepage](https://github.com/jonschlinkert/template)
157166
* [underscore](https://www.npmjs.com/package/underscore): JavaScript's functional programming helper library. | [homepage](http://underscorejs.org)
158167
* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://www.npmjs.com/package/verb) | [homepage](https://github.com/verbose/verb)
@@ -183,4 +192,4 @@ Released under the MIT license.
183192

184193
***
185194

186-
_This file was generated by [verb](https://github.com/verbose/verb) on January 12, 2016._
195+
_This file was generated by [verb](https://github.com/verbose/verb) on January 15, 2016._

0 commit comments

Comments
 (0)