Nourished Personal Mucus
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

metalsmith-include-content

1.0.1 • Public • Published

Metalsmith Include Content NPM version

A Metalsmith plugin that allows content to be included (nested) within other content by including the file path in the document.

Continuous testing courtesy of travis-ci:

Build Status

Installation

This package can be installed through npm:

npm install metalsmith-include-content

Usage

JavaScript

If you are using the JS api for Metalsmith, then you can require the module and add it to your .use() directives:

var include = require('metalsmith-include-content');
 
Metalsmith()
  .use(include())
  .build(function(err) {
 
  });

CLI

If you are using the command-line version of Metalsmith, you can install via npm, and then add the metalsmith-include-content key to your metalsmith.json file:

{
  "plugins": {
    "metalsmith-include-content": {
      "pattern": "^include (.*)",
      "ignoreMissing": false
    }
  }
}

Options

The plugin allows you to override the default behaviour by passing in options.

  • pattern is the regular expression pattern that is used for finding includes
  • ignoreMissing allows you to show or hide warnings if the include file does not exist

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.

install

npm i metalsmith-include-content

Downloadsweekly downloads

117

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability