diff options
Diffstat (limited to 'docs/api/README.md')
| -rw-r--r-- | docs/api/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 0000000..66b05b6 --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,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 |