remark-metadata

Add metadata about a Markdown file as Front Matter.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-metadata
120.2.16 years ago6 years agoMinified + gzip package size for remark-metadata in KB

Readme

remark-metadata
NPM Travis CI MIT License
Adds meta data about a Markdown file to a Markdown file, formatted as Front Matter.
The following meta data is added:
  • lastModifiedAt using one of the following heuristics:
1. the vFile has the property data.lastModifiedAt defined 1. if git exists, the commit time of the file 1. the mtime reported by Node's stat method.

Installation

$ npm install remark-metadata

Requires remark-frontmatter.

Usage

Given a file, example.md, which contains the following Markdown:

```md

title: Example

Example
This is an example
Using remark like follows:

```js
var vfile = require('to-vfile');
var remark = require('remark');
var frontmatter = require('remark-frontmatter');
var metadata = require('remark-metadata');

var example = vfile.readSync('example.md');

remark()
  .use(frontmatter)
  .use(metadata, { git: true })
  .process(example, function (err, file) {
    if (err) throw err;
    console.log(String(file))
    })
  });

This will output the following Markdown:

```md

title: Example lastModifiedDate: 'Tue, 28 Nov 2017 02:44:25 GMT'
Example
This is an example ```
If a file has no Front Matter, it will be added by this plugin.

Options

The plugin has the following options:
  • git: Enables determining modification dates using git (defaults: true)