metalsmith-serve

A metalsmith plugin to serve the build directory.

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

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

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.phpand /old_url.php?lang=enwill be redirected with 301headers.

Options

host

Type: StringDefault: localhost

Hostname or IP to listen on.

port

Type: NumberDefault: 8080

Port to listen on.

cache

Type: NumberDefault: 0

Number of seconds to cache served files

document_root

Type: StringDefault: metalsmith.destination()

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

verbose

Type: BooleanDefault: false

Log all requests

http_error_files

Type: ObjectDefault: undefined

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

e.g.

"http_error_files": {
  404: "/404.html"
}

redirects

Type: ObjectDefault: {}

Redirects with 301headers unless the file is located.

e.g.

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

License

MIT

HomePage

https://github.com/mayo/metalsmith-serve

Repository

https://github.com/mayo/metalsmith-serve


上一篇:dataset
下一篇:metalsmith-markdownit

相关推荐

  • 闲鱼前端基于serverless的一种多端开发解决方案

    背景 前端的发展太快了,前端框架和技术的发展也层出不穷,还包括不同智能设备的出现,对前端开发同学来说是个很大的跳转,简单列举下: 前端框架:vue、react、angular 小...

    7 个月前
  • 迈向 serverless 开发的第一步

    作者:Kamesh Sampath 翻译:疯狂的技术宅 原文:https://serverlessarchitectu...(https://serverlessarchitecture...

    6 个月前
  • 详解webpack-dev-server使用http-proxy解

    文档资料 webpack关于webpackdevserver开启proxy的官方介绍(http://webpack.github.io/docs/webpackdevserver.htmlproxy...

    2 年前
  • 用xshell和xftp建立远程连接访问ubuntu server

    1先打开 ubuntu server 2.打开那个xshell; 图片描述(https://img.javascriptcn.com/660d3b1bfbf4a0793f09448090a89...

    2 年前
  • 用 serverless 与 typescript 开发第一个 Koa 应用

    对于稍微大型的 Node 应用,typescript 已经是标配,它为 javascript 提供了强类型的铠甲,有效提高了代码质量。 这里是一个结合 ts 及 koa 快速部署到腾讯云函数计算中的模...

    2 个月前
  • 源码学习VUE之Observe

    在文章 源码学习VUE之响应式原理我们大概描述了响应式的实现流程,主要写了observe,dep和wather的简易实现,以及推导思路。但相应代码逻辑并不完善,今天我们再来填之前的一些坑。

    2 年前
  • 渐进式服务器端渲染SSR(Server Side Render)的解决方案

    前言 服务器端渲染有需要它独特的应用场景,此处不过多讨论SSR的必要性,只见到谈一下如何在没有条件使用SSR的时候如何解决问题。 为何需要服务器端渲染? 解决SEO问题:纯前端的项目...

    2 年前
  • 模式系统与最简单的Node.js MVC Web Server设计

    学了这么久的设计模式,最近一直在看的设计模式,一直纳闷为何会有模式这一类东西的存在,那么模式究竟是什么东西?后面在看了《面向模式的软件架构》之后才慢慢知道有了一些系统的概念。

    2 年前
  • 模块化开发神器 - webpack-dev-server

    不需要你知道任何东西,非常适合你作为新手脚手架,让你体验一把工程化开发、模块化开发的便利。 webpackdevserver 是个什么东西? 就是一个基于和的一个简易服务器。

    2 年前
  • 揭开React中server-side rending的神秘面纱

    原文地址:https://medium.freecodecamp.o...(https://medium.freecodecamp.org/demystifyingreactsserversider...

    2 年前

官方社区

扫码加入 JavaScript 社区