metalsmith-serve

A metalsmith plugin to serve the build directory. Best used in development and with metalsmith-watch.

Installation

$ npm install metalsmith-serve

Basic Example

``js
var metalsmith = require('metalsmith');
var serve = require('metalsmith-serve');

metalsmith(__dirname)
.use(serve())
.build(function(err) {
if (err) { throw err; }
});
`

This will serve Metalsmith's build directory on localhost:8080. By default, metalsmith-serve will only log error requests.

Advanced Example

`js
var metalsmith = require('metalsmith');
var serve = require('metalsmith-serve');

metalsmith(__dirname)
.use(serve({
port: 8081,
verbose: true,
http_error_files: {
404: "/404.html"
},
redirects: {
'/old_url.php' : '/new_url/',
'/old_url.php?lang=en': '/en/new_url/'
}
}))
.build(function(err) {
if (err) { throw err; }
});
`

This will serve Metalsmith's build directory on localhost:8081 and will show all served requests.
Requests for missing files will be served with the contents of /404.html.
/old_url.php and /old_url.php?lang=en will be redirected with 301 headers.




Options

$3


Type: String
Default: localhost

Hostname or IP to listen on.

$3

Type: Number
Default: 8080

Port to listen on.

$3

Type: Number
Default: 0

Number of seconds to cache served files

$3

Type: String
Default: metalsmith.destination()

Directory which to serve. Given path will be resolved with path.resolve()

$3


Type: Boolean
Default: false

Log all requests

$3

Type: Object
Default: undefined

Serves a corresponding file to error codes. The common usage is a 404 file if the requested file isn't located.

e.g.
`js
"http_error_files": {
404: "/404.html"
}
`

$3


Type: Object
Default: {}

Redirects with 301 headers unless the file is located.

e.g.
`js
"redirects": {
'/old_url.php' : '/new_url/',
'/old_url.php?lang=en': '/en/new_url/'
}
``

License

MIT