|
2 | 2 |
|
3 | 3 | > Markdown template helper. Uses remarkable to render markdown in templates. Should work with Handlebars, Lo-Dash or any template engine that supports helper functions.
|
4 | 4 |
|
| 5 | +- [Install](#install) |
5 | 6 | - [API](#api)
|
6 | 7 | - [Usage examples](#usage-examples)
|
7 | 8 | - [Register the helper](#register-the-helper)
|
|
18 | 19 |
|
19 | 20 | _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
|
20 | 21 |
|
| 22 | +## Install |
| 23 | + |
| 24 | +Install with [npm](https://www.npmjs.com/): |
| 25 | + |
| 26 | +```sh |
| 27 | +$ npm i helper-markdown --save |
| 28 | +``` |
| 29 | + |
21 | 30 | ## API
|
22 | 31 |
|
23 | 32 | ```js
|
@@ -152,7 +161,7 @@ _.template('<%= markdown("# heading") %>', {}, settings);
|
152 | 161 |
|
153 | 162 | * [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)
|
154 | 163 | * [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/) |
156 | 165 | * [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)
|
157 | 166 | * [underscore](https://www.npmjs.com/package/underscore): JavaScript's functional programming helper library. | [homepage](http://underscorejs.org)
|
158 | 167 | * [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.
|
183 | 192 |
|
184 | 193 | ***
|
185 | 194 |
|
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