JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 122523
  • Score
    100M100P100Q154060F
  • License MIT

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

Package Exports

  • helper-md

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (helper-md) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

helper-md NPM version NPM downloads 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 helper-md --save

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>

You might also be interested in these projects:

  • assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
  • handlebars-helpers: 120+ Handlebars helpers in ~20 categories, for Assemble, YUI, Ghost or any Handlebars project. Includes… 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.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on May 13, 2016.