A metalsmith plugin for a partial
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
README.md
index.js
package.json
wercker.yml

README.md

metalsmith-partial

A metalsmith plugin for a partial

This plugin provide 'partial' helper to include other templates. You can use any templating engine supported by consolidate.js.

Installation

$ npm install metalsmith-partial

Example

Source file src/index.html:

---
title: The title
---
<p>The contents</p>

{%- @partial('foobar.html') %}

Partial partials/foobar.html:

<p>This is a partial.</p>

Build file build.js:

var metalsmith = require('metalsmith');
var partial = require('metalsmith-partial');
var templates = require('metalsmith-templates');

metalsmith(__dirname)
  .source('./src')
  .destination('./dest')
  .use(partial({
    directory: './partials', 
    engine: 'eco'
  }))
  .use(templates({
    engine: 'eco',
    inPlace: true
  }))
  .build();

Results in dist/index.html:

<p>The contents</p>

<p>This is a partial</p>

License

MIT