summaryrefslogtreecommitdiffstats
path: root/docs/api/README.md
blob: c3beb6e0013b373da7f354649507482b498efda7 (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 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