A Metalsmith plugin to add metadata to every file in a collection
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.
.gitignore
LICENSE
README.md
index.js
package.json

README.md

metalsmith-collection-metadata

npm package version Dependency status JavaScript Standard Style

A Metalsmith plugin to add metadata to every file in a collection.

Requires metalsmith-collections.

Installation

$ npm install metalsmith-collection-metadata

Usage

To add metadata to a collection, you must assign a metadata object to a property that points to the location of that collection. For example:

import collections from 'metalsmith-collections'
import metadata from 'metalsmith-collection-metadata'

metalsmith
  .use(collections({
    pages: 'pages/*.md',
    posts: 'posts/*.md'
  }))
  .use(metadata({
    'collections.pages': {
      type: 'page'
    },
    'collections.posts': {
      type: 'post'
    }
  }))

Adds a type property to every file in the pages and posts collections.

License

MIT