stratic-extract-header

remark plugin to extract values from a standard Stratic header

DEPRECATED

This module is deprecated. It turns out that the Stratic header just isn't expressive enough and is t here for no good reason, really.

You should use gulp-grey-matter to parse YAML frontmatter instead. Accordingly, this package is unmaintained.

Installation

npm install stratic-extract-header

Usage

var remark = require('remark');
var extractHeader = require('stratic-extract-header');

var fileData = {}
var processor = remark().use(extractHeader, {data: fileData});

processor.process([
    '# Post information',
    '"Title", "0 UTC-0","Jane Doe", "some, categories"',
	'# Post text',
	'Some arbitrary Markdown content'
].join('\n'));

console.log(fileData);

Outputs:

{ title: 'Title',
  time: { epoch: '0', utcoffset: 'UTC-0' },
  author: 'Jane Doe',
  categories: [ 'some', 'categories' ] }

You must pass an options object to remark.use(). This object should contain one key, data, whose value is a reference to the object that stratic-extract-header will populate with metadata information.

License

LGPL 3.0+

Author

Alex Jordan [email protected]