diff options
author | Samy Pessé <samypesse@gmail.com> | 2016-02-22 08:59:19 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2016-02-22 08:59:19 +0100 |
commit | ccc585ca1fd47ea6cb24cf16b82fd58304840d9c (patch) | |
tree | d89c57b296ef9e8e637099ae1c234a367ba27d36 /docs | |
parent | 4dbe81cb660aa3422e4e5238459b48e357785c0c (diff) | |
download | gitbook-ccc585ca1fd47ea6cb24cf16b82fd58304840d9c.zip gitbook-ccc585ca1fd47ea6cb24cf16b82fd58304840d9c.tar.gz gitbook-ccc585ca1fd47ea6cb24cf16b82fd58304840d9c.tar.bz2 |
Add doc for plugins
Diffstat (limited to 'docs')
-rw-r--r-- | docs/plugins.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/plugins.md b/docs/plugins.md index e69de29..4d9e7b6 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -0,0 +1,22 @@ +# Plugins + +Plugins are the best way to extend GitBook functionalities (ebook and website). There exist plugins to do a lot of things: bring math formulas display support, track visits using Google Analytic, etc. + +### How to find plugins? + +Plugins can be easily searched on [plugins.gitbook.com](https://plugins.gitbook.com). + + +### How to install a plugin? + +Once you find a plugin that you want to install, you need to add it to your book.json: + +``` +{ + "plugins": ["myPlugin", "anotherPlugin"] +} +``` + +You can also specify a specific version using: "myPlugin@0.3.1". By default GitBook will resolve the latest version of the plugin compatbile with the current GitBook version. + +Plugins are automatically installed on [GitBook.com](https://www.gitbook.com). Locally, run `gitbook install` to install and prepare all plugins for your books. |