gitbook/docs/api

Plugin Architecture

A GitBook plugin is a NPM package that follow a defined convention.

gitbook-plugin is a command line utility to help you create, test and release plugins.

Bootstrap your first plugin

Install gitbook-plugin from NPM:

$ npm install gitbook-plugin -g

Then create your plugin using:

$ gitbook-plugin create

It will prompt you to enter a name and a description.

Publish your plugin