diff options
author | Samy Pessé <samypesse@gmail.com> | 2016-12-22 10:18:38 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-12-22 10:18:38 +0100 |
commit | 194ebc3da9641ff96f083f9d8ab43c2d27944f9a (patch) | |
tree | c50988f32ccf18df93ae7ab40be78e9459642818 /docs/api/README.md | |
parent | 64ccb6b00b4b63fa0e516d4e35351275b34f8c07 (diff) | |
parent | 16af264360e48e8a833e9efa9ab8d194574dbc70 (diff) | |
download | gitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.zip gitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.tar.gz gitbook-194ebc3da9641ff96f083f9d8ab43c2d27944f9a.tar.bz2 |
Merge pull request #1543 from GitbookIO/dream
React for rendering website with plugins
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 |