https://github.com/chkal/metalsmith-build-info

Metalsmith plugin to add various build infos to the metadata.
https://github.com/chkal/metalsmith-build-info

Last synced: about 6 hours ago
JSON representation

Metalsmith plugin to add various build infos to the metadata.

• Host: GitHub
• URL: https://github.com/chkal/metalsmith-build-info
• Owner: chkal
• License: mit
• Created: 2017-02-28T11:25:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-05-24T09:59:21.000Z (over 7 years ago)
• Last Synced: 2024-10-31T18:12:47.728Z (17 days ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# metalsmith-build-info

[![npm](https://img.shields.io/npm/v/metalsmith-build-info.svg)](https://www.npmjs.com/package/metalsmith-build-info)

[![Build Status](https://travis-ci.org/chkal/metalsmith-build-info.svg?branch=master)](https://travis-ci.org/chkal/metalsmith-build-info)

Metalsmith plugin to add various build infos to the metadata.

## Installation

```bash

npm install metalsmith-build-info --save-dev

```

    

## Usage

```js

var buildinfo = require("metalsmith-build-info");

Metalsmith(__dirname)

  /* ... */

  .use(buildinfo())

  /* ... */

```

The plugin will set the following metadata:

  * `buildinfo.date`: The date at which the site was generated.

  * `buildinfo.user`: The user who generated the site (i.e. `travis`).

  * `buildinfo.nodejs`: The version of Node.js used to generate the site (i.e. `v6.9.2`).

  * `buildinfo.arch`: String identifying the processor architecture that the Node.js 

    is currently running on (i.e. `x64`).

  * `buildinfo.platform`: String  identifying the operating system platform on which the 

    Node.js process is running on (i.e. `linux`).

  * `buildinfo.version`: The version of Metalsmith used to generate the site (i.e. `2.3.0`)

## License

MIT