Nutritious Pumpkin Masses

metalsmith-date-formatter

1.0.2 • Public • Published

Metalsmith Date Formatter

Build Status

Format article/post dates based on YAML Front Matter (YFM) data and moment

## Installation

npm install --save-dev metalsmith-date-formatter

Usage

Front Matter:

---
publishDate: 2015-05-30
modifedDate: 2015-05-31
---

JavaScript API:

var Metalsmith = require('metalsmith');
var dateFormatter = require('metalsmith-date-formatter');
 
Metalsmith()
    .use(dateFormatter());

In your template::

<p>published: {{ publishDate }}</p>
<p>last modified: {{ modifiedDate }}</p>

options

dates

This option takes multiple formats

array of objects with key and format properties.

  • The key property is the YFM property name
  • The format property is optional but takes any moment format value
.use(dateFormatter({
    dates: [
        {
            key: 'publishDate',
            format: 'MM DD YYYY'
        },
        {
            key: 'modifiedDate',
            format: 'MM YYYY'
        }
    ]
})

array of strings

.use(dateFormatter({
    dates: ['publishDate', 'modifiedDate']
})

string

.use(dateFormatter({
    dates: 'publishDate'
})

format

Any date format that moment accepts, defaults to MMMM DD, YYYY

Notes

The metalsmith cli workflow has not been tested

Keywords

install

npm i metalsmith-date-formatter

Downloadsweekly downloads

47

version

1.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability