# metalsmith-serve

> A metalsmith plugin to serve the build directory.

Latest version **0.0.7** (published 2016-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install metalsmith-serve
pnpm add metalsmith-serve
yarn add metalsmith-serve
bun add metalsmith-serve
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2016-01-06 |
| First published | 2014-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 30 |
| Author | Mayo Jordanov |
| Maintainers | mayo |
| Keywords | metalsmith, webserver, development |

## Links

- npm: https://www.npmjs.com/package/metalsmith-serve
- Repository: https://github.com/mayo/metalsmith-serve
- Issues: https://github.com/mayo/metalsmith-serve/issues
- npm.io page: https://npm.io/package/metalsmith-serve

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^0.4.0
- [http-status](https://npm.io/package/http-status.md) ^0.2.0
- [node-static](https://npm.io/package/node-static.md) ^0.7.7

## Recent versions

- 0.0.7 (latest) — 2016-01-06
- 0.0.6 — 2015-11-16
- 0.0.4 — 2015-09-11
- 0.0.3 — 2014-12-04
- 0.0.1 — 2014-10-23

## README

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

# 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](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.

### cache
Type: `Number`
Default: `0`

Number of seconds to cache served files

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

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

### verbose
Type: `Boolean`
Default: `false`

Log all requests

### http_error_files
Type: `Object`
Default: `undefined`

Serves a corresponding file to error codes.  The common usage is a [404](https://en.wikipedia.org/wiki/HTTP_404) file if the requested file isn't located.

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

### 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

---
_Source: https://npm.io/package/metalsmith-serve · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
