JavaScript
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
yarn.lock

README.md

metalsmith-auto-collections

Automatically use metalsmith-collections. The collection name is equal to the parent directory of each file.

Installation

yarn add metalsmith-auto-collections [-D]

Usage

const Metalsmith = require('metalsmith')
const collect = require('metalsmith-auto-collections')

const ms = Metalsmith(__dirname)

// add all files to a collection
ms.use(collect())

// use globs to only set certain files to a collection
ms.use(collect({
  pattern: ['**/*.md', '!*.md']
}))

// pass settings to `metalsmith-collections`
ms.use(collect({
  pattern: '**/*.md',
  settings: {
    sortBy: 'date',
    reverse: true
  }
}))

To see the available options, see the metalsmith-collections repo.