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

# @fidian/metalsmith-serve

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

This is a fork that uses updated packages to remove problems reported by `npm audit`.

## Installation

    $ npm install @fidian/metalsmith-serve

## Basic Example

```js
var metalsmith = require('metalsmith');
var serve = require('@fidian/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('@fidian/metalsmith-serve');

metalsmith(__dirname)
  .use(serve({
    port: 8081,
    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](https://en.wikipedia.org/wiki/HTTP_301) headers.


## Options

### host
Type: `String`
Default: `localhost`

Hostname or IP to listen on.

### port
Type: `Number`
Default: `8080`

Port to listen on.

### document_root
Type: `String`
Default: `metalsmith.destination()`

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

### redirects
Type: `Object`
Default: `{}`

Redirects with [301](https://en.wikipedia.org/wiki/HTTP_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