Skip to content

README.md

Latest commit

 

History

History
47 lines (30 loc) · 1.25 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.25 KB

bot-koa-prerender

NPM

KOA middleware for prerendering javascript-rendered pages on the fly for SEO

This koa middleware intercepts requests to your Node.js website from bots, and then makes a call to the (external) Prerender service to get the static HTML instead of the javascript for that page.

Setup

Prerequisites

Install Prerender on a server of your choice.

Install

Install the package with npm:

$ npm install bot-koa-prerender`

Usage

var prerender = require('bot-koa-prerender');

// Options
var options = {
  prerender: PRERENDER_SERVER_URL   // optional, default:'http://service.prerender.io/'
  protocol: 'http',                 // optional, default: this.protocol
  host: 'www.risingstack.com',      // optional, default: this.host,
  prerender_token: ''               // optional or process.env.PRERENDER_TOKEN
};

// Use as middleware
app.use(prerender(options));

Heavily inspired by

Gergely Nemeth mail@nemethgergely.com (http://twitter.com/nthgergo)

License

MIT