helper-md

    0.2.2 • Public • Published

    helper-md NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Markdown template helper. Uses remarkable to render markdown in templates. Should work with Handlebars, Lo-Dash or any template engine that supports helper functions.

    Install

    Install with npm:

    $ npm install --save helper-md

    Usage examples

    Views

    With assemble:

    var assemble = require('assemble');
    var app = assemble();
     
    // create a collection (this is already done in assemble)
    app.create('partials', {viewType: 'partial'});
     
    // load a template onto the collection
    app.partial('foo', {content: '# {{title}}', title: 'Heading'});

    Use the helper, specify the name of the view you want to convert to HTML

    {{md "foo"}}

    Files

    Or, you can specify a filepath to include content from external files.

    {{md "posts/foo.md"}}

    Both result in something like:

    <h1>Heading</h1>

    About

    Related projects

    • assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
    • handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
    • helper-markdown: Markdown template helper. Uses remarkable to render markdown in templates. Should work with Handlebars, Lo-Dash… more | homepage
    • templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
    • verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

    Contributors

    Commits Contributor
    14 jonschlinkert
    1 jonjhiggins
    1 ScottPolhemus

    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Running tests

    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:

    $ npm install && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2017, Jon Schlinkert. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.4.3, on March 31, 2017.

    Install

    npm i helper-md

    DownloadsWeekly Downloads

    95,272

    Version

    0.2.2

    License

    MIT

    Last publish

    Collaborators

    • avatar
    • avatar