permalinks-date-helpers

permalinks-date-helpers

Plugin for Permalinks that adds date helpers and variables to the context.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save permalinks-date-helpers

Usage

var dateHelpers = require('permalinks-date-helpers');
var Permalinks = require('permalinks');
var permalinks = new Permalinks();

permalinks.use(dateHelpers());
var file = {path: 'posts/about.md', data: {date: '2017-02-02'}};
permalinks.format(':year/:month/:day/:stem/index.html');
//=> '2017/02/02/about/index.html'

permalinks.format(':date("YYYY/MM/DD")/:stem/index.html');
//=> '2017/02/02/about/index.html'

Helpers

:date

Uses moment to create a formatted date string from the given format and optional date.

Params

• format {String}
• date {String|Date}
• returns {String}

Example

permalinks.format(':date', file);
//=> '2017-02-15'
permalinks.format(':date()', file);
//=> '2017-02-15'
permalinks.format(':date("MM")', file);
//=> '02'
permalinks.format(':date("YYYY")', file);
//=> '2017'
permalinks.format(':date("DD")', file);
//=> '15'
permalinks.format(':date("dddd, MMMM Do YYYY, h:mm:ss a")', file);
//=> 'Sunday, February 14th 2017, 3:25:50 pm'
permalinks.format(':slugify(date("dddd, MMMM Do YYYY, h:mm:ss a"))', file);
//=> 'sunday-february-14th-2017-3-25-50-pm'

Variables

In addition to the date helper itself, the following variables will be exposed on the context as a result of registering the date helper (these aren't helpers, just strings):

Name	Description	Example
:year	Published year of posts (4-digit)	2017
:month	Published month of posts (2-digit)	09
:i_month	Published month of posts (Without leading zeros)	9
:day	Published day of posts (2-digit)	02
:i_day	Published day of posts (Without leading zeros)	2
:hour	Hour of the day	11
:minute	Minute of the hour	15
:second	Second of the minute	45

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• gulp-permalinks: Gulp plugin for easily creating permalinks for vinyl files. | homepage
• permalinks: Easily add powerful permalink or URL routing/URL rewriting capablities to any node.js project. Can be… more | homepage
• static-rewrite: Easily generate destination paths or static URLs by mapping user-friendly patterns to server-side build paths. | homepage

Author

Jon Schlinkert

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on January 11, 2018.