Skip to content
Sample plugin for GitBook
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
book
.gitignore
LICENSE
README.md
index.js
package.json

README.md

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.

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.

You can’t perform that action at this time.