Adds meta data about a Markdown file to a Markdown file, formatted as Front Matter.
The following meta data is added:
-
lastModifiedAt
using the last commit time of the file fromgit
-
lastModifiedHash
using the last commit hash of the file fromgit
-
lastModifiedBy
using the last commit author name of the file fromgit
-
lastModifiedEmail
using the last commit author email of the file fromgit
$ npm install remark-git-metadata
Requires remark-frontmatter
.
Given a file, example.md
, which contains the following Markdown:
---
title: Example
---
# Example
This is an example
Using remark like follows:
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:
---
title: Example
lastModifiedAt: 'Tue, 28 Nov 2017 02:44:25 GMT'
lastModifiedHash: '5820fe3db899ea7ebf997a661df92780cbe25250'
lastModifiedBy: 'Joel Jeske'
lastModifiedAt: 'joel@jeske.com'
---
# Example
This is an example
If a file has no Front Matter, it will be added by this plugin.