diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 18 insertions, 3 deletions
@@ -3,7 +3,7 @@ GitBook [](https://travis-ci.org/GitbookIO/gitbook) -GitBook is a command line tool (and Node.js library) for building beautiful programming books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](http://gitbookio.github.io/javascript/). +GitBook is a command line tool (and Node.js library) for building beautiful programming books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](http://gitbookio.github.io/javascript/). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter.  @@ -35,11 +35,13 @@ Options for commands `build` and `serve` are: -g, --github <repo_path> ID of github repo like : username/repo -o, --output <directory> Path to output directory, defaults to ./_book -f, --format <name> Change generation format, defaults to site, availables are: site, page, pdf, json --i, --intro <intro> Description of the book to generate --githubHost <url> The url of the github host (defaults to https://github.com/) ---theme <path> Path to theme directory +--plugins <plugins> List of plugins to use separated by "," +--pluginsConfig <json file> JSON File containing plugins configuration ``` +You can publish your books to our index by visiting [GitBook.io](http://www.gitbook.io) + ## Output Formats GitBook can generate your book in the following formats: @@ -132,3 +134,16 @@ You can see a complete example with the [Learn Git](https://github.com/GitbookIO #### Ignoring files & folders GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip. (The format inside those files, follows the same convention as `.gitignore`) + +#### Plugins + +PLugins can used to extend your book functionnalities. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more informations about how to build a plugin for gitbook. + +##### Default plugins: + +* [mathjax](https://github.com/GitbookIO/plugin-mathjax): displays mathematical notation in the book. +* [mixpanel](https://github.com/GitbookIO/plugin-mixpanel): Mixpanel tracking for your book + +##### Other plugins: + +* [Google Analytics](https://github.com/GitbookIO/plugin-ga): Google Analytics tracking for your book |