gitbook-plugin-layout

<<<<<<< HEAD gitbook-plugin-layout

gitbook install gitbook-plugin-layout

book.json

    "plugins": ["layout"],
     "pluginsConfig": {
        "layout": {
        	"headerPath" : "layouts/header.html",
        	"footerPath" : "layouts/footer.html"
        }
    },

======= GitBook Sample Plugin

This is a model for GitBook plugins.

How GitBook plugin works?

A plugin for GitBook is a node package that can be published on NPM. It has to follow the name convention: gitbook-plugin-*name*.

package.json

name

The package name should begin with gitbook-plugin-.

Examples: gitbook-plugin-mixpanel, gitbook-plugin-googleanalytics.

a61a89e2f73e5cd1ce9b40a6df653bd82832a2ce

engine

The package.json should contain a engine field using the standard norm.

"engines": {
    "gitbook": "*"
}

For example if you want your plugin to supports only GitBook version supperior to 0.3.1:

"engines": {
    "gitbook": ">=0.3.1"
}

entry point

The plugin entry point should return an object with some metadata.