Project: temando/remark-metadata

Package: remark-metadata@0.2.1

  1. Dependents: 0
  2. Add metadata about a Markdown file as Front Matter.
  1. remark 214
  2. remark-plugin 82


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:


$ npm install remark-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');

  .use(metadata, { git: true })
  .process(example, function (err, file) {
    if (err) throw err;

This will output the following Markdown:

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.


The plugin has the following options: