gulp-marked-mustache
Markdown with Mustache templates populated using YAML front-matter.
Installation
$ npm install --save-dev gulp-marked-mustache
Basic usage
'use strict';
var gulp = require('gulp');
var markedMustache = require('gulp-marked-mustache');
gulp.task('markdown', function () {
gulp.src('./markdown/*.md')
.pipe(markedMustache(options))
.pipe(gulp.dest('./dist'));
});
API
options
This package uses marked, Mustache.js and node-toc, although with slightly different defaults. You can pass through options for most of these components.
markdown
Type: object
Accepts any valid marked options.
partials
Type: object
An object containing any Mustache partials. This correlates with the partials parameter in the Mustache.render() method. Note that the other two parameters, template and view, are populated automatically based on the Markdown file's front matter and content.
templatePath
Type: string
The path to the Mustache templates, including trailing slash. Defaults to ./default/
toc
Type: object, boolean
Accepts any valid node-toc options. Set to false to globally disable inclusion.
updateLinks
Type: boolean
Updates relative links to Markdown documents to their HTML equivalent. For example, <a href="index.md"> would be changed to <a href="index.html">, but <a href="http://www.example.com/index.md"> would not be affected.
Front Matter
All front matter in markdown is added to the Mustache view. In addition, the template field will select the corresponding Mustache template, while the toc field can be set to false to prevent the table of contents from being included.
Mustache templating
Almost any fields added to the Markdown file's front matter are accessible within the template.
The two exception are body and toc. The former contains the rendered HTML of the markdown body; the latter either contains the raw HTML of the table of contents, or is not present if the table of contents is not included.
At its simplest, your template may look something like this:
<!DOCTYPE html>
<html>
<head>
<title>{{title}}</title>
</head>
<body>
{{{body}}}
{{{toc}}}
</body>
</html>Note the triple mustache on the body and toc variables, as these are raw HTML.