https://github.com/temando/remark-metadata

Add metadata about a Markdown file as Front Matter.
https://github.com/temando/remark-metadata

remark remark-plugin

Last synced: 7 days ago
JSON representation

Add metadata about a Markdown file as Front Matter.

• Host: GitHub
• URL: https://github.com/temando/remark-metadata
• Owner: temando
• License: mit
• Created: 2017-11-28T03:18:57.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-10-24T16:53:43.000Z (about 4 years ago)
• Last Synced: 2024-11-02T03:06:36.728Z (12 days ago)
• Topics: remark, remark-plugin
• Language: JavaScript
• Size: 41 KB
• Stars: 1
• Watchers: 4
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# remark-metadata

[![NPM](https://img.shields.io/npm/v/remark-metadata.svg)](https://npmjs.org/packages/remark-metadata/)

[![Travis CI](https://img.shields.io/travis/temando/remark-metadata.svg)](https://travis-ci.org/temando/remark-metadata)

[![MIT License](https://img.shields.io/github/license/temando/remark-metadata.svg)](https://en.wikipedia.org/wiki/MIT_License)

Adds meta data about a Markdown file to a Markdown file, formatted as [Front Matter](https://jekyllrb.com/docs/frontmatter/).

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`](https://git-scm.com/) exists, the commit time of the file

  1. the `mtime` reported by Node's `stat` method.

## Installation

```sh

$ npm install remark-metadata

```

Requires [`remark-frontmatter`](https://github.com/wooorm/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`)