summaryrefslogtreecommitdiffstats
path: root/docs/api/README.md
blob: 66b05b6f80c47b216e3ea76e3d1bfc05b1b70e4a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Plugin Architecture

A GitBook plugin is a NPM package that follows 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:

```
$ gitbook-plugin create
```

You will be asked for a plugin name, and a few other things to complete the creation process.


### Publish your plugin