Metalsmith plugin to register all environmental variables as metadata.
npm install --save metalsmith-env
If you are using the command-line version of Metalsmith, you can install via npm, and then add the metalsmith-env
key to your metalsmith.json
file:
{
"plugins": {
"metalsmith-env": {}
}
}
If you are using the JS Api for Metalsmith, then you can require the module and add it to your .use()
directives:
var env = require('metalsmith-env');
metalsmith.use(env());
Once installed, all environment variables, from process.env
, become available as Metalsmith metadata.
An array of default variables that will be available. Environmental variables will then override the default set.
An array of variables that will completely override the given set of environmental variables.
The assumed environmental variables, defaults to process.env
.
Store the environmental variables under a metadata[metadatakey]
instead of merging into metadata
.
The following example uses Jade and Metalsmith JSTransformer:
---
title: Environmental Variables
---
doctype html
html(lang="en")
head
title= title
body
h1= title
p This is the environmental variable "NODE_ENV":
code
pre= NODE_ENV
$ NODE_ENV=production node_modules/.bin/metalsmith
<!DOCTYPE html>
<html lang="en">
<head>
<title>Environmental Variables</title>
</head>
<body>
<h1>Environmental Variables</h1>
<p>This is the environmental variable "NODE_ENV":</p>
<code><pre>production</pre></code>
</body>
</html>
MIT