Bump version to 4.0.0-alpha.2 🚀

* Add tests for summaryFromDocument

* Add tests for summaryToDocument

* Add tests for untitled parts (HR)

.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,4 @@
+docs/**/*
+_book/**/*
+node_modules/**/*
+test/**/*

.eslintrc

@@ -0,0 +1,11 @@
+{
+    "env": {
+        "node": true,
+        "browser": true,
+        "mocha": true
+    },
+    "globals": {
+        "expect": true
+    },
+    "extends": "gitbook"
+}

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,30 @@
+<!--
+              IMPORTANT NOTICE
+  Only post things related to the gitbook CLI
+  For GitBook.com, the Editor, or anything else
+  please go to
+  https://github.com/GitbookIO/feedback/issues
+
+  Please open separate issues for each bug report.
+-->
+
+
+### What is the current behavior?
+
+<!--
+  - For bugs, provide the steps to reproduce
+  - Provide the GitBook version being used (`gitbook -V`)
+  - Provide system informations (OS and version)
+  - Provide your username and the URL of the book
+-->
+
+
+
+### What is the expected behavior?
+
+
+
+<!--
+  Thank you for giving us your feedback!
+  -- The GitBook Team
+-->

.gitignore

@@ -24,8 +24,15 @@ build/Release
 # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
 node_modules
 
-theme/javascript/vendors
-theme/vendors
-
 # vim swapfile
 *.swp
+
+# GitBook with babel
+/packages/gitbook-core/lib
+/packages/gitbook-plugin/lib
+
+# Output of documentation
+_book
+book.pdf
+book.epub
+book.mobi

.travis.yml

@@ -1,4 +1,14 @@
+sudo: false
 language: node_js
+os:
+  - linux
+  - osx
 node_js:
-  - "0.11"
-  - "0.10"
+  - "stable"
+  - "4.1"
+before_install:
+  - npm install svgexport -g
+before_script:
+  - npm run bootstrap
+after_success:
+  - npm run lint

AUTHORS.md

@@ -7,12 +7,62 @@ Names below are ordered by first contribution.
 Author
 ------
 
-- Samy Pessé <samypesse@gmail.com>
-- Aaron O'Mullan <aaron.omullan@gmail.com>
-
+- Samy Pessé <samy@gitbook.com> (@SamyPesse)
+- Aaron O'Mullan <aaron@gitbook.com> (@AaronO)
+- Johan Preynat <johan@gitbook.com> (@jpreynat)
+- Nicolas Gaborit <nicolas@gitbook.com> (@soreine)
 
 Contributors
 ------------
 
-- Nijiko Yonskai
-- Herman Starikov
+- Nijiko Yonskai (@Nijikokun)
+- Herman Starikov (@Hermanya)
+
+Translators
+------------
+
+- German
+    - Winnie (@winniehell)
+- Italian
+    - Giulio Bonanome (@gbonanome)
+- Russian
+    - Andrey Akinshin (@AndreyAkinshin)
+- Norwegian
+    - Knut Melvær (@kmelve)
+- Persian (Farsi)
+    - Mohammad Hossein Mojtahedi (@mhm5000)
+- Polish
+    - Łukasz Szeremeta (@lszeremeta)
+- Portuguese
+    - Ryan O'Mullan (@RyanOM)
+- Spanish
+    - Ryan O'Mullan (@RyanOM)
+- Simplifiled Chinese
+    - Hu Hao (@howiehu)
+- Traditional Chinese
+    - Hu Hao (@howiehu)
+- French
+    - Samy Pessé (@SamyPesse)
+- Romanian
+        - Iancu Aurel (@awrelll)
+- Finnish
+    - Tommi Savikko (@savikko)
+- Japanese
+    - Iancu Aurel (@awrelll)
+- Korean
+    - Iancu Aurel (@awrelll)
+    - SangYeob Yu (@deminoth)
+- Vietnamese
+    - Hong Nguyen (@nghong)
+- Hebrew
+    - @a-moses
+- Ukrainian
+    - @Karnaukhov
+- Czech
+    - @mjanda
+- Swedish
+    - Jacob Burenstam (@buren)
+- Turkish
+    - Turan Konan (@turankonan)
+- Catalan
+    - Esaú García Sánchez-Torija (@egasato)

CHANGES.md

@@ -1,4 +1,330 @@
 # Release notes
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 4.0.0
+- **Breaking Changes:** Most plugins and themes should be incompatible with this version
+- GitBook rendering is now done using React, which brings better APIs for plugins and a more interactive website.
+- *Performances*: Installation of plugins is much faster thanks to `ied`
+- *Performances*: Git conrefs are faster over large books
+- *Website Feature:* new default plugin `copy-code` to copy code blocks content in one click
+- *Website Feature:* new default plugin `heading-anchors` to have clickable headings
+- *Website Feature:* `fontsettings` is now only controlling the font size, and can work on multiple themes
+- *Plugin API*: hook `page` can no longer modify the content, only the page's attributes
+- *Plugin API*: plugins can no longer export resources, instead use the `_assets` folder
+- [ ] *Plugin API*: testing framework
+- [ ] `gitbook init` creates `.gitignore` if not found
+- [ ] Ignore files are no longer copied to the output
+
+## 3.2.2
+- Fix catching parsing errors leading to possible missing pages in generated book
+- Rollback markdown parser to `kramed` until `markup-it` is stable enough
+
+## 3.2.1
+- Fix bug on Firefox when navigating to an url containing an hash
+- Update nunjucks to fix JS error when page contains a lot of templating blocks
+
+## 3.2.0
+- Switch markdown parser from `kramed` to `markup-it`
+- Fix support of `|` in tables
+- Fix access to `output.name` in templating
+- Fix i18n for website and PDF
+- Fix minor scrolling issues on website
+- Improve options of default search indexer (keywords, disabling per pages)
+- Improve pertinence of search results
+
+## 3.1.1
+- Fix order of plugins during loading
+- Fix error when using math and conrefs
+- Fix target attribute for external links
+- Fix serve command
+
+## 3.1.0
+- Always load themes after plugins
+- README/Introduction doesn't require to be the first entry in the summary
+- Highlight active entry in summary when scrolling a page with anchors
+- Support empty parts in summary
+
+## 3.0.3
+- Fix redirection in `gitbook serve` when accessing a folder without trailing slash
+- Fix links/annotations for glossary not being correctly resolved
+- Fix regression for supporting uppercase filenames in structure files
+- Fix `gitbook install` when using Git URLs for plugins
+
+## 3.0.2
+- Fix crash for anchor links
+
+## 3.0.1
+- Fix regression in link resolution when contain anchor
+- Fix `structure.<name>` configuration not supporting filenames with dots
+
+## 3.0.0
+- Summary can contain external links and anchors (Fix [#776](https://github.com/GitbookIO/gitbook/issues/776))
+- Summary can contain differents entitled sections
+- Glossary is generated as a normal page
+- Headings are no longer annotated with glossary terms
+- Themes are now published as a plugin, with ability to extend it from the book source
+- `links.sidebar` configuration is no longer supported, use summary sections instead
+- `pdf.headerTemplate` and `pdf.footerTemplate` have been replaced by a template in theme/book: `_layout/ebook/pdf_header.html` and `_layout/ebook/pdf_footer.html`
+- Markdown parser is now using CommonMark
+- Root folder for the book can be specified in the `"root"` property of the `book.json` file
+- Multi-lingual books share assets folder
+- YAML front matter is parsed and can extend page's properties
+- Fix `uk` translation
+- Fix heading ID including dashes
+- Fix error in code highlighting for unknown languages
+- Fix data-uri images being handled as external images
+- Accept SSH url as plugin version
+- Add templating blocks `markdown`, `asciidoc` and `markup`
+- Better search experience
+- Better default theme, more responsive and cleaner
+
+## 2.6.7
+- Fix bug with filenames including spaces
+- Add Turkish and Catalan translations
+
+## 2.6.6
+- Fix custom CSS that are generated by plugins for PDF output
+
+## 2.6.5
+- Fix support for plugins generating custom stylesheets (`styles-less` and `styles-sass`)
+- Fix glossary terms being replaced in script (ex: math)
+
+## 2.6.4
+- Fix regression introduced by `2.6.3` of single HTML tags in markdown
+
+## 2.6.3
+- Fix parsing bug with inline HTML in Markdown
+
+## 2.6.2
+- Fix `gitbook.state.bookRoot`, `gitbook.state.root` now has a trailing slash
+- Update nunjucks to 2.2.0
+
+## 2.6.1
+- Use CamelCase for `gitbook.state.innerLanguage`
+
+## 2.6.0
+- Close sidebar after clicking a link on mobile
+- Add root for multilingual books: `gitbook.state.bookRoot`
+- Fix color of h6 headings
+- Fix bottom margin of lists and blockquotes
+- Add Swedish translation (`sv`)
+- Add Czech translation (`cs`)
+- Fix locale names for `zh-hans` and `jp`
+- Update plugin `search` to fix crashes
+- Aceept case-incensitive structure files (README, GLOSSARY, etc)
+
+## 2.5.2
+- Fix custom stylesheets for ebook generation
+- Trigger event `start` before `page.change`
+
+## 2.5.1
+- Fix calcul of `gitbook.state.root` when serving HTML index as `/`
+
+## 2.5.0
+- Font settings, sharing and search are externalized as default plugins
+- Plugins can define a configuration schema in the manifest, this schema will be used to validate configuration during build
+- New Node.js API for plugin: `book.formatString(type, content)`
+- New client side API for website plugins: `gitbook.toolbar.createButton(opts)`
+- Better header/footer for PDF, CSS wil be inlined to easily style the header/footer
+- Cleaner table of contents for ebooks
+- Support for RTL in ebook's table of contents
+- Better colors for mobi (links and code blocks)
+- Fix installation of plugins when using a pre-release
+- Fix support for pre-releases
+- Update asciidoc parser to remove git dependency
+- Fix templating in imported content
+- Fix querystring in image urls
+- Normalize heading IDs like GitHub
+- Use Arial as default font for PDFs
+- Add `root`, `chapterTitle` and `filepath` to `gitbook.state` JS API
+
+## 2.4.3
+- Add ukrainian translation (`uk`)
+- Add `book.json` configuration for maximum size of search index
+- Improve reliability of summary parser
+
+## 2.4.2
+- Default plugins should not be installed by `gitbook install`
+- Limit search index size to avoid crash during generation
+- Fix code highlighting for html without language specified
+- Fix warning message for gitbook version when building a multilingual book
+
+## 2.4.1
+- Fix disabling of default plugins, ex: `-highlight`
+
+## 2.4.0
+- Fix page being updated when user wants to open a link in a new tab
+- Plugins can now replaced default code highlighter
+- Add semantic information for screen readers (web version)
+- Content references accept absolute paths, resolved to book folder
+- Improve overall reliability
+
+## 2.3.3
+- Fix bug in SUMMARY parsing preventing multiple entries without filenames
+
+## 2.3.2
+- Fix blocks (like maths) in Asciidoc
+- Fix error when checking gitbook version
+
+## 2.3.1
+- Fix black font color for ebooks (mobi, pdf and epub)
+- Fix ISO code for korean language
+- Fix korean translation
+- Fix syntax highlighting for asciidoc
+- Fix inline html escaping in markdown
+- Add warning for file outside SUMMARY
+- Force SUMMARY entries to be unique by filename
+
+## 2.3.0
+- Fix nunjucks issue with multiple `{% raw %}` blocks
+- Fix crash when git conref failed
+- Fix crash when failed to download remote image (better error message)
+- Fix flicking effect when changing page (big UX improvement)
+- Add Hebrew translation (`he`)
+- Add utility method `book.config.get` for plugins
+- Hooks `page:before` and `page` are no longer deprecated
+- Remove webfonts to make website lighter
+- Make glossary's order case insensitive
+
+## 2.2.0
+- Fix direction in code blocks (always LTR)
+- Add options `chapterMark` and `pageBreaksBefore` for PDF
+- Update code highlighting library
+- `book.json` accessible as `config` in templating syntax
+- Add Vietnamese translation (`vi`)
+
+## 2.1.0
+- Fix error in calcul of `levels` in table of contents, error introduced a few versions ago
+- Add optional `styles/print.css` to replace `print.css` used in ebook
+
+## 2.0.4
+- Fix `{% raw %}`, got confused with "fake" variable declarations
+- Fix title of language chooser
+- Fix the X-UA-Compatible meta tag
+- Move style sheets to the <head> section
+
+## 2.0.3
+- Fix `gitbook init` for SUMMARY with empty entries
+- Fix escaping of code blocks in markdown
+
+## 2.0.2
+- Fix relative links in windows
+- Improve watcher in serve command (switch to chokidar)
+- Add Romanian translation (`ro`)
+- Add Finish translation (`fi`)
+- Add Japanese translation (`jp`)
+- Add Korean translation (`kr`)
+
+## 2.0.1
+- Improve error logging (display file, line and column)
+- Add back support for `options.originalInput`
+- Don't process math in markdown parser (delegated to `mathjax` plugin)
+- Fix some cases of code blocks escaping
+- Fix i18n for introduction title in json format
+- Fix reload when book configuration is updated
+- Fix backslashes in url when building on windows
+
+## 2.0.0
+- Fix page title of introduction
+- Ignore codeblocks when replacing glossary terms
+- Improve Unit Tests
+- Fix scrolling position in website when preparing page
+
+## 2.0.0-beta.5
+- Fix progress order in json format
+
+## 2.0.0-beta.4
+- Fix default generator for use programmatically
+- Add option "author" for html meta tags
+- Fix links normalization (content and hash)
+
+## 2.0.0-beta.3
+- Fix odd cases with code blocks escaping
+
+## 2.0.0-beta.2
+- Fix definition of entry point title using SUMMARY.md
+
+## 2.0.0-beta.1
+- Fix windows incompatibility
+- Add support for rtl (enabled by default for `ar` and `fa`)
+- Escape code blocks in markdown parser
+- Add Persian/Farsi translation (`fa`)
+- Add Arabic translation (`ar`)
+- Add Bengali translation (`bn`)
+- Provide generator name in template context
+
+## 2.0.0-alpha.9
+- Fix links in sidebar
+- Fix normalization of html link (README to index)
+- Fix html snippets escaping
+
+## 2.0.0-alpha.8
+- Improve locale detection for i18n
+- Fix chapter name for Glossary in pdf
+- Don't escape html in glossary items
+- Fix generation of multilingual book as ebook
+- Add "post" block attribute to post-process
+
+## 2.0.0-alpha.7
+- Fix display of glossary in ebook formats
+- Add default footer and header to pdf
+- Fix generation of json format compatible with 1.x.x
+- Add Simplifiled Chinese and Traditional Chinese translations
+
+## 2.0.0-alpha.6
+- Add es and pt translations
+- Fix replacement of glossary terms
+
+## 2.0.0-alpha.5
+- Fix copy of files/covers
+- Add back `finish:before` hook
+
+## 2.0.0-alpha.4
+- Fix copy of cover for multilingal books
+
+## 2.0.0-alpha.3
+- Norwegian translation
+- Load plugins from book in priority
+
+## 2.0.0-alpha.3
+- Fix init command
+- Update parsers to fix spaces in summary (`gitbook-parsers@0.3.1`)
+
+## 2.0.0-alpha.1
+- Externalize parsing into `gitbook-parsers` module
+- Supports AsciiDoc and reStructuredText
+- Hooks for page (`page:*`) are now deprecated, plugins should extend filters and blocks instead
+- Hooks `summary` and `glossary` (after and before) have been removed
+- Exercises and Quizzes are no longer parsed in the markdown parser
+- Support for more markdown extensions: `.markdown`, `.mdown`
+- Templates are rendered with nunjucks instead of swig, syntax is almost compatible, there is some changes with contexts and filters. `{{ super() }}` should be use instead of `{% parent %}`
+- Clean output folder on build without removing `.git` and `.svn`
+- MathJAX is no longer a default plugin
+- SVG images are converted to PNG during generation of ebooks
+- i18n in website and ebook (ru, it, de, fr)
+- New templating syntax
+- Content references (both internal and external)
+- Glossary terms are handled during generation (also in ebook format)
+
+## 1.5.0
+- Fix `serve` command, broken by `1.4.2`
+- Add nicer `dark` theme :)
+
+## 1.4.2
+- Force `process.exit` after builds, to prevent (possibly) lingering plugins
+
+## 1.4.1
+- Fix command 'install' without arguments
+
+## 1.4.0
+- Add command `gitbook install` to install plugins from book.json
+- `package.json` is no longer necessary
+
+## 1.3.4
+- Add glossary to ebooks
+- Fix autocover with new hook "finish:before"
+- Add X-UA-Compatible meta tag for IE
 
 ## 1.3.3
 - Fix parsing of lexed content using the client library

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+
+# Contributing
+
+Want to contribute to GitBook? That would be awesome!
+
+- [Send feedback](#send-feedback)
+- [Reporting Bugs](#reporting-bugs)
+- [Asking Questions](#asking-questions)
+- [Submitting Pull Requests](#submitting-pull-requests)
+- [Running Tests](#running-tests)
+
+## Send feedback
+
+We’ve done our best to test but your feedback is really important. If you encounter problems or have feedback about GitBook products (GitBook.com, GitBook Editor, or the Toolchain), please log an issue in the [GitbookIO/feedback](https://github.com/GitbookIO/feedback/issues) repository.
+
+
+## Reporting Bugs
+
+If you run into any weird behavior while using GitBook, feel free to open a new issue in this repository! To be most helpful, please include the steps to reproduce the bug as best you can, including the output of command `gitbook -V`.
+
+## Asking Questions
+
+Questions are very welcome :smile:! Previous questions that folks have asked are tagged with a [`question`](https://github.com/GitBookIO/gitbook/issues?q=is%3Aissue+is%3Aclosed+label%3Aquestion) label, so before opening a new issue double-check that someone hasn't asked it before. But if you don't see anything, or if you're not sure if it's the same, err on the side of asking!
+
+We've also got a [GitBook Community Slack](https://slack.gitbook.com/) where you can ask questions and get answers from other people using GitBook.
+
+## Submitting Pull Requests
+
+All pull requests are super welcomed and greatly appreciated! Easy issues are marked with an [`easy-one`](https://github.com/GitBookIO/gitbook/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy-one) label if you're looking for a simple place to get familiar with the code base.
+
+Please include tests and docs with every pull request!
+
+## Running Tests
+
+To run the examples, you need to have the GitBook repository cloned to your computer. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm` using `yarn`.
+
+```
+$ yarn install
+```
+
+Then you'll need to bootstrap it:
+
+```
+$ npm run bootstrap
+```
+
+Which will also compile the source files. Then run the tests with:
+
+```
+$ npm test
+```

Gruntfile.js

@@ -1,129 +0,0 @@
-module.exports = function (grunt) {
-    var path = require("path");
-
-    // Load NPM tasks
-    grunt.loadNpmTasks('grunt-contrib-copy');
-    grunt.loadNpmTasks('grunt-contrib-less');
-    grunt.loadNpmTasks('grunt-contrib-requirejs');
-    grunt.loadNpmTasks("grunt-bower-install-simple");
-    grunt.loadNpmTasks('grunt-browserify');
-    grunt.loadNpmTasks('grunt-contrib-uglify');
-
-    // Init GRUNT configuraton
-    grunt.initConfig({
-        pkg: grunt.file.readJSON('package.json'),
-        'bower-install-simple': {
-            options: {
-                color:       true,
-                production:  false,
-                directory:   "theme/vendors"
-            }
-        },
-        less: {
-            development: {
-                options: {
-                    compress: true,
-                    yuicompress: true,
-                    optimization: 2
-                },
-                files: {
-                    "theme/assets/style.css": "theme/stylesheets/website.less",
-                    "theme/assets/print.css": "theme/stylesheets/ebook.less"
-                }
-            }
-        },
-        requirejs: {
-            compile: {
-                options: {
-                    name: "gitbook",
-                    baseUrl: "theme/javascript/",
-                    out: "theme/assets/app.js",
-                    preserveLicenseComments: false,
-                    optimize: "uglify",
-                    include: ["requireLib"],
-                    paths: {
-                        "jQuery": '../vendors/jquery/dist/jquery',
-                        "lodash": '../vendors/lodash/dist/lodash',
-                        "requireLib": '../vendors/requirejs/require',
-                        "Mousetrap": '../vendors/mousetrap/mousetrap',
-                        "lunr": '../vendors/lunr.js/lunr',
-                        "URIjs": '../vendors/URIjs/src/',
-                        "ace": '../vendors/ace-builds/src-noconflict/'
-                    },
-                    shim: {
-                        'jQuery': {
-                            exports: '$'
-                        },
-                        'lodash': {
-                            exports: '_'
-                        },
-                        'Mousetrap': {
-                            exports: 'Mousetrap'
-                        },
-                        'lunr': {
-                            exports: 'lunr'
-                        }
-                    }
-                }
-            }
-        },
-        copy: {
-            vendors: {
-                files: [
-                    {
-                        expand: true,
-                        cwd: 'theme/vendors/fontawesome/fonts/',
-                        src: ['**'],
-                        dest: 'theme/assets/fonts/fontawesome/',
-                        filter: 'isFile'
-                    }
-                ]
-            }
-        },
-        browserify: {
-            dist: {
-                files: {
-                    'gitbook.js': [
-                        './lib/parse/index.js'
-                    ],
-                },
-                options: {
-                    postBundleCB: function (err, src, next) {
-                        return next(null, '(function () { var define = undefined; '+src+'; })();')
-                    },
-                    browserifyOptions: {
-                        'standalone': "gitbook"
-                    }
-                }
-            }
-        },
-        uglify: {
-            dist: {
-                files: {
-                    'gitbook.min.js': ['gitbook.js']
-                }
-            }
-        }
-    });
-
-    grunt.registerTask("bower-install", [ "bower-install-simple" ]);
-
-    // Build
-    grunt.registerTask('build', [
-        'bower-install',
-        'less',
-        'requirejs',
-        'copy:vendors'
-    ]);
-
-    // Bundle the library
-    grunt.registerTask('bundle', [
-        'browserify',
-        'uglify'
-    ]);
-
-    grunt.registerTask('default', [
-        'build',
-        'bundle'
-    ]);
-};

README.md

@@ -1,249 +1,59 @@
-GitBook
-=======
+[![GitBook](https://raw.github.com/GitbookIO/gitbook/master/docs/images/banner.png)](https://www.gitbook.com)
 
-[![Build Status](https://travis-ci.org/GitbookIO/gitbook.png?branch=master)](https://travis-ci.org/GitbookIO/gitbook)
-[![NPM version](https://badge.fury.io/js/gitbook.svg)](http://badge.fury.io/js/gitbook)
+<p align="center">A <em>modern</em> customizable documentation format and toolchain</p>
 
-GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown. Here is an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). You can publish book easily online using [gitbook.io](https://www.gitbook.io) and an [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. Complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
 
-![Image](https://raw.github.com/GitbookIO/gitbook/master/preview.png)
+<p align="center"><a href="#features"><strong>Features</strong></a> · <a href="https://www.gitbook.com"><strong>Hosting</strong></a> · <a href="http://redux.js.org/"><strong>Example</strong></a> · <a href="https://www.gitbook.com/editor"><strong>Editor</strong></a> · <a href="https://toolchain.gitbook.com/"><strong>Documentation</strong></a> · <a href="./CONTRIBUTING.md"><strong>Contributing!</strong></a> · <a href="https://twitter.com/GitBookIO"><strong>Twitter</strong></a></p>
+<br/>
 
-## How to use it:
+![Preview](https://raw.github.com/GitbookIO/gitbook/master/docs/images/preview.png)
 
-GitBook can be installed from **NPM** using:
 
-```
-$ npm install gitbook -g
-```
+<p align="center">
+<img src="https://badge.fury.io/js/gitbook.svg" />
+<a href="https://travis-ci.org/GitbookIO/gitbook"><img src="https://travis-ci.org/GitbookIO/gitbook.png?branch=master" /></a>
+<a href="https://ci.appveyor.com/project/GitBook/gitbook"><img src="https://ci.appveyor.com/api/projects/status/63nlflxcwmb2pue6?svg=true" /></a>
+<a href="https://ci.appveyor.com/project/GitBook/gitbook"><img src="https://slack.gitbook.com/badge.svg" /></a>
+</p>
 
-You can serve a repository as a book using:
-
-```
-$ gitbook serve ./repository
-```
-
-Or simply build the static website using:
-
-```
-$ gitbook build ./repository --output=./outputFolder
-```
+GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: [ReduxJS documentation](http://redux.js.org/).
 
-Options for commands `build` and `serve` are:
+You can publish and host books easily online using [gitbook.com](https://www.gitbook.com). A desktop editor is [also available](https://www.gitbook.com/editor).
 
-```
--o, --output <directory>  Path to output directory, defaults to ./_book
--f, --format <name>       Change generation format, defaults to site, availables are: site, page, ebook, json
---config <config file>    Configuration file to use, defaults to book.js or book.json
-```
+Check out the [GitBook Community Slack Channel](https://slack.gitbook.com), Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
 
-GitBook loads the default configuration from a `book.json` file in the repository if it exists.
+Complete documentation is available at [toolchain.gitbook.com](http://toolchain.gitbook.com/).
 
-Here are the options that can be stored in this file:
+## Getting started
 
-```js
-{
-    // Folders to use for output
-    // Caution: it overrides the value from the command line
-    // It's not advised this option in the book.json
-    "output": null,
+GitBook can be used either on your computer for building local books or on GitBook.com for hosting them. To get started, check out [the installation instructions in the documentation](docs/setup.md).
 
-    // Generator to use for building
-    // Caution: it overrides the value from the command line
-    // It's not advised this option in the book.json
-    "generator": "site",
+## Usage examples
 
-    // Book title and description (defaults are extracted from the README)
-    "title": null,
-    "description": null,
+GitBook can be used to create book, public documentation, enterprise manual, thesis, research papers, etc.
 
-    // For ebook format, the extension to use for generation (default is detected from output extension)
-    // "epub", "pdf", "mobi"
-    // Caution: it overrides the value from the command line
-    // It's not advised this option in the book.json
-    "extension": null,
+You can find a [list of real-world examples](docs/examples.md) in the documentation.
 
-    // Plugins list, can contain "-name" for removing default plugins
-    "plugins": [],
+## Help and Support
 
-    // Global configuration for plugins
-    "pluginsConfig": {
-        "fontSettings": {
-            "theme": "sepia", "night" or "white",
-            "family": "serif" or "sans",
-            "size": 1 to 4
-        }
-    },
+We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at [gitbook.com/contact](https://www.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook).
 
-    // Variables for templating
-    "variables": {},
+## Features
 
-    // Links in template (null: default, false: remove, string: new value)
-    "links": {
-    	// Custom links at top of sidebar
-    	"sidebar": {
-    	    "Custom link name": "https://customlink.com"
-    	},
+* Write using [Markdown](http://toolchain.gitbook.com/syntax/markdown.html) or [AsciiDoc](http://toolchain.gitbook.com/syntax/asciidoc.html)
+* Output as a website or [ebook (pdf, epub, mobi)](http://toolchain.gitbook.com/ebook.html)
+* [Multi-Languages](http://toolchain.gitbook.com/languages.html)
+* [Lexicon / Glossary](http://toolchain.gitbook.com/lexicon.html)
+* [Cover](http://toolchain.gitbook.com/ebook.html)
+* [Variables and Templating](http://toolchain.gitbook.com/templating/)
+* [Content References](http://toolchain.gitbook.com/templating/conrefs.html)
+* [Plugins](http://toolchain.gitbook.com/plugins/)
+* [Beautiful default theme](https://github.com/GitbookIO/theme-default)
 
-        // Sharing links
-        "sharing": {
-            "google": null,
-            "facebook": null,
-            "twitter": null,
-            "weibo": null,
-            "all": null
-        }
-    },
+## Publish your book
 
+The platform [GitBook.com](https://www.gitbook.com/) is like an "Heroku for books": you can create a book on it (public, or private) and update it using **git push**.
 
-    // Options for PDF generation
-    "pdf": {
-        // Add page numbers to the bottom of every page
-        "pageNumbers": false,
+## Licensing
 
-        // Font size for the fiel content
-        "fontSize": 12,
-
-        // Paper size for the pdf
-        // Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’]
-        "paperSize": "a4",
-
-        // Margin (in pts)
-        // Note: 72 pts equals 1 inch
-        "margin": {
-            "right": 62,
-            "left": 62,
-            "top": 36,
-            "bottom": 36
-        },
-
-        //Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
-        "headerTemplate": null,
-
-        //Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
-        "footerTemplate": null
-    }
-}
-```
-
-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:
-
-* **Static Website**: This is the default format. It generates a complete interactive static website that can be, for example, hosted on GitHub Pages.
-* **eBook**: A complete eBook with exercise solutions at the end of the book. Generate this format using: ```gitbook ebook ./myrepo```. You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed. The output format could be **PDF**, **ePub** or **MOBI**.
-* **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo -f json```.
-
-## Book Format
-
-A book is a Git repository containing at least 2 files: `README.md` and `SUMMARY.md`.
-
-#### README.md
-
-Typically, this should be the introduction for your book. It will be automatically added to the final summary.
-
-#### SUMMARY.md
-
-The `SUMMARY.md` defines your book's structure. It should contain a list of chapters, linking to their respective pages.
-
-Example:
-
-```markdown
-# Summary
-
-This is the summary of my book.
-
-* [section 1](section1/README.md)
-    * [example 1](section1/example1.md)
-    * [example 2](section1/example2.md)
-* [section 2](section2/README.md)
-    * [example 1](section2/example1.md)
-```
-
-Files that are not included in `SUMMARY.md` will not be processed by `gitbook`.
-
-#### Multi-Languages
-
-GitBook supports building books written in multiple languages. Each language should be a sub-directory following the normal GitBook format, and a file named `LANGS.md` should be present at the root of the repository with the following format:
-
-```markdown
-* [English](en/)
-* [French](fr/)
-* [Español](es/)
-```
-
-You can see a complete example with the [Learn Git](https://github.com/GitbookIO/git) book.
-
-#### Glossary
-
-Allows you to specify terms and their respective definitions to be displayed in the glossary. Based on those terms, `gitbook` will automatically build an index and highlight those terms in pages.
-
-The `GLOSSARY.md` format is very simple :
-
-```markdown
-# term
-Definition for this term
-
-# Another term
-With it's definition, this can contain bold text and all other kinds of inline markup ...
-
-```
-
-#### 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`).
-
-Best practices for the `.gitignore` is to ignore build files from **node.js** (`node_modules`, ...) and build files from GitBook: `_book`, `*.epub`, `*.mobi` and `*.pdf` ([Download GitBook.gitignore](https://github.com/github/gitignore/blob/master/GitBook.gitignore)).
-
-#### Cover
-
-A cover image can be set by creating a file: **/cover.jpg**.
-The best resolution is **1800x2360**. The generation of the cover can be done automatically using the plugin [autocover](https://github.com/GitbookIO/plugin-autocover).
-
-A small version of the cover can also be set by creating a file: **/cover_small.jpg**.
-
-#### Publish your book
-
-The platform [GitBook.io](https://www.gitbook.io/) is like an "Heroku for books": you can create a book on it (public, paid, or private) and update it using **git push**.
-
-#### Plugins
-
-Plugins can be used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for GitBook.
-
-##### Official plugins:
-
-| Name | Description |
-| ----- | ---- |
-| [exercises](https://github.com/GitbookIO/plugin-exercises) | Add interactive exercises to your book. |
-| [quizzes](https://github.com/GitbookIO/plugin-quizzes) | Add interactive quizzes to your book. |
-| [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 |
-| [infinitescroll](https://github.com/GitbookIO/gitbook-plugin-infinitescroll) | Infinite Scrolling |
-
-##### Other plugins:
-
-| Name | Description |
-| ----- | ---- |
-| [Google Analytics](https://github.com/GitbookIO/plugin-ga) | Google Analytics tracking for your book |
-| [Disqus](https://github.com/GitbookIO/plugin-disqus) | Disqus comments integration in your book |
-| [Autocover](https://github.com/GitbookIO/plugin-autocover) | Generate a cover for your book |
-| [Transform annoted quotes to notes](https://github.com/erixtekila/gitbook-plugin-richquotes) | Allow extra markdown markup to render blockquotes as nice notes |
-| [Send code to console](https://github.com/erixtekila/gitbook-plugin-toconsole) | Evaluate javascript block in the browser inspector's console |
-| [Revealable sections](https://github.com/mrpotes/gitbook-plugin-reveal) | Reveal sections of the page using buttons made from the first title in each section |
-| [Markdown within HTML](https://github.com/mrpotes/gitbook-plugin-nestedmd) | Process markdown within HTML blocks - allows custom layout options for individual pages |
-| [Bootstrap JavaScript plugins](https://github.com/mrpotes/gitbook-plugin-bootstrapjs) | Use the [Bootstrap JavaScript plugins](http://getbootstrap.com/javascript) in your online GitBook |
-| [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik) | Piwik Open Analytics tracking for your book |
-| [Heading Anchors](https://github.com/rlmv/gitbook-plugin-anchors) | Add linkable Github-style anchors to headings |
-| [JSBin](https://github.com/jcouyang/gitbook-plugin-jsbin) | Embedded jsbin frame into your book |
-| [gitbook-grvis](https://github.com/romanlytkin/gitbook-grvis) | Gitbook GrViz plugin is used to select from markdown dot and converting it into a picture format svg |
-| [gitbook-plantuml](https://github.com/romanlytkin/gitbook-plantuml) | Gitbook PlantUml plugin is used to select from markdown uml and converting it into a picture format svg |
-
-#### Debugging
-
-You can use the environment variable `DEBUG=true` to get better error messages (with stack trace). For example:
-
-```
-$ export DEBUG=true
-$ gitbook build ./
-```
+GitBook is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.

appveyor.yml

@@ -0,0 +1,38 @@
+# Fix line endings in Windows. (runs before repo cloning)
+init:
+  - git config --global core.autocrlf input
+
+# Test against these versions of Node.js.
+environment:
+  matrix:
+    - nodejs_version: "6"
+    - nodejs_version: "5"
+    - nodejs_version: "4"
+
+matrix:
+  fast_finish: true
+
+# Install scripts. (runs after repo cloning)
+install:
+  # Get the latest stable version of Node.js or io.js
+  - ps: Install-Product node $env:nodejs_version
+  - set CI=true
+  # install svgexport
+  - npm install svgexport -g
+  # install modules
+  - npm install
+
+# Post-install test scripts.
+test_script:
+  # Output useful info for debugging.
+  - node --version
+  - npm --version
+  # run tests
+  - npm test
+
+# Don't actually build.
+build: off
+
+# Clone only last commit
+shallow_clone: true
+clone_depth: 1

bin/build.js

@@ -1,63 +0,0 @@
-var path = require('path');
-var Q = require('q');
-var _ = require('lodash');
-var fs = require('fs');
-
-var utils = require('./utils');
-var generate = require("../lib/generate");
-var parse = require("../lib/parse");
-var generators = require("../lib/generate").generators;
-
-var buildCommand = function(command) {
-    return command
-    .option('-v, --verbose', 'Activate verbose mode, useful for debugging errors')
-    .option('-o, --output <directory>', 'Path to output directory, defaults to ./_book')
-    .option('-f, --format <name>', 'Change generation format, defaults to site, availables are: '+_.keys(generators).join(", "))
-    .option('--config <config file>', 'Configuration file to use, defaults to book.js or book.json');
-};
-
-
-var buildEbookCommand = function(command) {
-    return buildCommand(command)
-    .option('-c, --cover <path>', 'Cover image, default is cover.jpg if exists');
-};
-
-var makeBuildFunc = function(converter) {
-    return  function(dir, options) {
-        dir = dir || process.cwd();
-        outputDir = options.output;
-
-        // Set debugging
-        if(options.verbose) {
-            process.env.DEBUG = "true";
-        }
-
-        console.log('Starting build ...');
-        return converter(
-            _.extend({}, options || {}, {
-                input: dir,
-                output: outputDir,
-                generator: options.format,
-                configFile: options.config
-            })
-        )
-        .then(function(output) {
-            console.log("Successfully built!");
-            return output;
-        })
-        .fail(function(err) {
-            // Log error
-            utils.logError(err);
-
-            // Exit process with failure code
-            process.exit(-1);
-        });
-    };
-};
-
-module.exports = {
-    folder: makeBuildFunc(generate.folder),
-    file: makeBuildFunc(generate.file),
-    command: buildCommand,
-    commandEbook: buildEbookCommand
-};

bin/gitbook.js

@@ -1,137 +0,0 @@
-#! /usr/bin/env node
-
-var Q = require('q');
-var _ = require('lodash');
-var path = require('path');
-var prog = require('commander');
-var tinylr = require('tiny-lr-fork');
-
-var pkg = require('../package.json');
-var generators = require("../lib/generate").generators;
-var initDir = require("../lib/generate/init");
-var fs = require('../lib/generate/fs');
-
-var utils = require('./utils');
-var build = require('./build');
-var Server = require('./server');
-var platform = require("./platform");
-
-// General options
-prog
-.version(pkg.version);
-
-build.command(prog.command('build [source_dir]'))
-.description('Build a gitbook from a directory')
-.action(build.folder);
-
-build.command(prog.command('serve [source_dir]'))
-.description('Build then serve a gitbook from a directory')
-.option('-p, --port <port>', 'Port for server to listen on', 4000)
-.option('--no-watch', 'Disable restart with file watching')
-.action(function(dir, options) {
-    var server = new Server();
-
-    // init livereload server
-    var lrOptions = {port: 35729};
-    var lrServer = tinylr(lrOptions);
-    var lrPath = undefined;
-    lrServer.listen(lrOptions.port, function(err) {
-      if (err) { return console.log(err); }
-      console.log('Live reload server started on port: ' + lrOptions.port);
-    });
-
-    var generate = function() {
-        if (server.isRunning()) console.log("Stopping server");
-
-        server.stop()
-        .then(function() {
-            return build.folder(dir, _.extend(options || {}, {
-                defaultsPlugins: ["livereload"]
-            }));
-        })
-        .then(function(_options) {
-            console.log();
-            console.log('Starting server ...');
-            return server.start(_options.output, options.port)
-            .then(function() {
-                console.log('Serving book on http://localhost:'+options.port);
-
-                if (lrPath) {
-                  // trigger livereload
-                  lrServer.changed({body:{files:[lrPath]}})
-                }
-
-                if (!options.watch) return;
-                return utils.watch(_options.input)
-                .then(function(filepath) {
-                    // set livereload path
-                    lrPath = filepath;
-                    console.log("Restart after change in files");
-                    console.log('');
-                    return generate();
-                })
-            })
-        })
-        .fail(utils.logError);
-    };
-
-    console.log('Press CTRL+C to quit ...');
-    console.log('')
-    generate();
-});
-
-build.commandEbook(prog.command('pdf [source_dir]'))
-.description('Build a gitbook as a PDF')
-.action(function(dir, options) {
-    build.file(dir, _.extend(options, {
-        extension: "pdf",
-        format: "ebook"
-    }));
-});
-
-build.commandEbook(prog.command('epub [source_dir]'))
-.description('Build a gitbook as a ePub book')
-.action(function(dir, options) {
-    build.file(dir, _.extend(options, {
-        extension: "epub",
-        format: "ebook"
-    }));
-});
-
-build.commandEbook(prog.command('mobi [source_dir]'))
-.description('Build a gitbook as a Mobi book')
-.action(function(dir, options) {
-    build.file(dir, _.extend(options, {
-        extension: "mobi",
-        format: "ebook"
-    }));
-});
-
-prog
-.command('init [source_dir]')
-.description('Create files and folders based on contents of SUMMARY.md')
-.action(function(dir) {
-    dir = dir || process.cwd();
-    return initDir(dir);
-});
-
-prog
-.command('publish [source_dir]')
-.description('Publish content to the associated gitbook.io book')
-.action(function(dir) {
-    dir = dir || process.cwd();
-    return platform.publish(dir);
-});
-
-prog
-.command('git:remote [source_dir] [book_id]')
-.description('Adds a git remote to a book repository')
-.action(function(dir, bookId) {
-    dir = dir || process.cwd();
-    return platform.remote(dir, bookId);
-});
-
-// Parse and fallback to help if no args
-if(_.isEmpty(prog.parse(process.argv).args) && process.argv.length === 2) {
-    prog.help();
-}

bin/platform.js

@@ -1,53 +0,0 @@
-var Q = require("q");
-var utils = require("./utils");
-
-var publish = function(folder) {
-    if (!folder) {
-        console.log("Need a repository folder");
-        return process.exit(-1);
-    }
-
-    utils.gitCmd("push", ["gitbook", "master"])
-    .then(function(out) {
-        console.log(out.stdout);
-    }, function(err) {
-        if (err.code == 128) {
-            console.log("No book on gitbook.io is configured with this git repository.");
-            console.log("Run 'gitbook git:remote username/book' to intialize this repository.");
-        } else {
-            console.log(err.message);
-        }
-        process.exit(-1);
-    });
-};
-
-var remote = function(folder, bookId) {
-    if (!folder || !bookId) {
-        console.log("Need a repository folder and a book id");
-        return process.exit(-1);
-    }
-
-    var url = "https://push.gitbook.io/"+bookId+".git";
-    var addRemote = function() {
-        return utils.gitCmd("remote", ["add", "gitbook", url]);
-    }
-
-    addRemote()
-    .fail(function(err) {
-        if (err.code == 128) {
-            return utils.gitCmd("remote", ["rm", "gitbook"]).then(addRemote);
-        }
-        return Q.reject(err);
-    })
-    .then(function(out) {
-        console.log("Book remote '"+url+"' added to the folder");
-    }, function(err) {
-        console.log(err.message);
-        process.exit(-1);
-    });
-};
-
-module.exports = {
-    publish: publish,
-    remote: remote
-};

bin/server.js

@@ -1,96 +0,0 @@
-var Q = require('q');
-var _ = require('lodash');
-
-var events = require('events');
-var http = require('http');
-var send = require('send');
-var util = require('util');
-var url = require('url');
-
-var Server = function() {
-    this.running = null;
-    this.dir = null;
-    this.port = 0;
-    this.sockets = [];
-};
-util.inherits(Server, events.EventEmitter);
-
-// Return true if the server is running
-Server.prototype.isRunning = function() {
-    return this.running != null;
-};
-
-// Stop the server
-Server.prototype.stop = function() {
-    var that = this;
-    if (!this.isRunning()) return Q();
-
-    var d = Q.defer();
-    this.running.close(function(err) {
-        that.running = null;
-        that.emit("state", false);
-
-        if (err) d.reject(err);
-        else d.resolve();
-    });
-
-    for (var i = 0; i < this.sockets.length; i++) {
-        this.sockets[i].destroy();
-    }
-
-    return d.promise;
-};
-
-Server.prototype.start = function(dir, port) {
-    var that = this, pre = Q();
-    port = port || 8004;
-
-    if (that.isRunning()) pre = this.stop();
-    return pre
-    .then(function() {
-        var d = Q.defer();
-
-        that.running = http.createServer(function(req, res){
-            // Render error
-            function error(err) {
-                res.statusCode = err.status || 500;
-                res.end(err.message);
-            }
-
-            // Redirect to directory's index.html
-            function redirect() {
-                res.statusCode = 301;
-                res.setHeader('Location', req.url + '/');
-                res.end('Redirecting to ' + req.url + '/');
-            }
-
-            // Send file
-            send(req, url.parse(req.url).pathname)
-            .root(dir)
-            .on('error', error)
-            .on('directory', redirect)
-            .pipe(res);
-        });
-
-        that.running.on('connection', function (socket) {
-            that.sockets.push(socket);
-            socket.setTimeout(4000);
-            socket.on('close', function () {
-                that.sockets.splice(that.sockets.indexOf(socket), 1);
-            });
-        });
-
-        that.running.listen(port, function(err) {
-            if (err) return d.reject(err);
-
-            that.port = port;
-            that.dir = dir;
-            that.emit("state", true);
-            d.resolve();
-        });
-
-        return d.promise;
-    });
-}
-
-module.exports = Server;

bin/utils.js

@@ -1,66 +0,0 @@
-var Q = require('q');
-var _ = require('lodash');
-
-var exec = require('child_process').exec;
-var http = require('http');
-var send = require('send');
-
-var path = require('path');
-var Gaze = require('gaze').Gaze;
-
-function watch(dir) {
-    var d = Q.defer();
-    dir = path.resolve(dir);
-
-    var gaze = new Gaze("**/*.md", {
-        cwd: dir
-    });
-
-    gaze.once("all", function(e, filepath) {
-        gaze.close();
-
-        d.resolve(filepath);
-    });
-    gaze.once("error", function(err) {
-        gaze.close();
-
-        d.reject(err);
-    });
-
-    return d.promise;
-}
-
-function logError(err) {
-    var message = err.message || err;
-    if (process.env.DEBUG != null) message = err.stack || message;
-    console.log(message);
-    return Q.reject(err);
-};
-
-function runGitCommand(command, args) {
-    var d = Q.defer(), child;
-    args = ["git", command].concat(args).join(" ");
-
-    child = exec(args, function (error, stdout, stderr) {
-        if (error !== null) {
-            error.stdout = stdout;
-            error.stderr = stderr;
-            d.reject(error);
-        } else {
-            d.resolve({
-                stdout: stdout,
-                stderr: stderr
-            })
-        }
-    });
-
-    return d.promise;
-};
-
-
-// Exports
-module.exports = {
-    watch: watch,
-    logError: logError,
-    gitCmd: runGitCommand
-};

book.js

@@ -0,0 +1,20 @@
+var pkg = require('./package.json');
+
+module.exports = {
+    // Documentation for GitBook is stored under "docs"
+    root: './docs',
+    title: 'GitBook Toolchain Documentation',
+
+    // Use the "official" theme
+    plugins: ['sitemap'],
+
+    variables: {
+        version: pkg.version
+    },
+
+    pluginsConfig: {
+        sitemap: {
+            hostname: 'https://toolchain.gitbook.com'
+        }
+    }
+};

bower.json

@@ -1,13 +0,0 @@
-{
-    "name": "GitBook",
-    "version": "1.0.0",
-    "dependencies": {
-        "jquery": "2.1.1",
-        "lodash": "2.4.1",
-        "requirejs": "2.1.11",
-        "URIjs": "1.13.1",
-        "mousetrap": "1.4.6",
-        "lunr.js": "0.5.2",
-        "fontawesome": "4.1.0"
-    }
-}

docs/README.md

@@ -0,0 +1,25 @@
+# GitBook Toolchain Documentation
+
+This document aims to be a comprehensive guide to GitBook. It contains the full documentation for version **{{ book.version }}**. Help for GitBook.com specific questions can be found at [help.gitbook.com](https://help.gitbook.com).
+
+### What is GitBook?
+
+GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). This documentation has been generated using GitBook.
+
+GitBook can output your content as a website ([customizable](themes/README.md) and [extensibles](plugins/README.md)) or as an ebook (PDF, ePub or Mobi).
+
+[GitBook.com](https://www.gitbook.com) is the online platform to create and host books built using the GitBook format. It offers hosting, collaboration features and an [easy-to-use editor](https://www.gitbook.com/editor).
+
+### Help and Support
+
+We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at [gitbook.com/contact](https://www.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook).
+
+Check out the [GitBook Community Slack Channel](https://slack.gitbook.com), Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
+
+### FAQ
+
+Some questions are frequently asked. If you have a problem you should [check this out](faq.md) first.
+
+### Contribute to this documentation
+
+You can contribute to improve this documentation on [GitHub](https://github.com/GitbookIO/gitbook) by signaling issues or proposing changes.

docs/SUMMARY.md

@@ -0,0 +1,56 @@
+# Summary
+
+### Getting Started
+
+* [About this documentation](README.md)
+* [Installation and Setup](setup.md)
+
+### Your Content
+
+* [Directory structure](structure.md)
+* [Pages and Summary](pages.md)
+* [Configuration](config.md)
+* [Glossary](lexicon.md)
+* [Multi-Lingual](languages.md)
+* [Markdown](syntax/markdown.md)
+    * [Headings](syntax/markdown.md#headings)
+    * [Paragraphs](syntax/markdown.md#paragraphs)
+    * [Emphasis](syntax/markdown.md#emphasis)
+    * [Lists](syntax/markdown.md#lists)
+    * [Links](syntax/markdown.md#links)
+    * [Images](syntax/markdown.md#images)
+    * [Blockquotes](syntax/markdown.md#blockquotes)
+    * [Tables](syntax/markdown.md#tables)
+    * [Code](syntax/markdown.md#code)
+    * [HTML](syntax/markdown.md#html)
+    * [Footnotes](syntax/markdown.md#footnotes)
+* [AsciiDoc](syntax/asciidoc.md)
+* [eBook and PDF](ebook.md)
+
+### Customization
+
+* [Templating](templating/README.md)
+    * [Content References](templating/conrefs.md)
+    * [Variables](templating/variables.md)
+    * [Builtin](templating/builtin.md)
+* [Plugins](plugins/README.md)
+    * [Create a plugin](plugins/create.md)
+    * [Hooks](plugins/hooks.md)
+    * [Blocks](plugins/blocks.md)
+    * [Filters](plugins/filters.md)
+    * [API & Context](plugins/api.md)
+    * [Test your plugin](plugins/testing.md)
+* [Theming](themes/README.md)
+
+### Plugin Development
+
+* [Introduction](./api/README.md)
+* [Node](./api/node.md)
+* [Connect to the context](./api/connect.md)
+* [Components](./api/components.md)
+
+--
+
+* [FAQ](faq.md)
+* [Examples](examples.md)
+* [Release notes](https://github.com/GitbookIO/gitbook/blob/master/CHANGES.md)

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

docs/api/components.md

@@ -0,0 +1,86 @@
+# Components
+
+
+## Injection
+
+Plugins can inject components by registering React components to some roles.
+
+#### Register a components
+
+During the initialization phase of your plugin, dispatch the `GitBook.registerComponent` action:
+
+```js
+dispatch(GitBook.registerComponent(MyCustomButton, { role: 'toolbar:buttons:left' }));
+```
+
+#### Roles
+
+Custom roles can be use for interopability with other plugins, but GitBook and the default theme set a convention for common roles:
+
+| Role | Description | Props |
+| ---- | ----------- | ----- |
+| `page:container` | DIV container for the page's content | `{ page: Page }` |
+| `summary:container` | DIV container for the whole summary | `{ summary: Summary }` |
+| `summary:parts` | DIV container for summary's parts | `{ parts: List<SummaryPart> }` |
+| `summary:part` | DIV for a specific part | `{ part: SummaryPart }` |
+| `summary:articles` | UL container for a part's articles | `{ articles: List<SummaryArticle> }` |
+| `summary:article` | LI for a specific article | `{ article: SummaryArticle }` |
+
+## Default Components
+
+#### `GitBook.Head`
+
+Extends the meta tags of the page. This is an alias for [react-helmet](https://github.com/nfl/react-helmet).
+
+```js
+<GitBook.Head
+    title="My page"
+  />
+```
+
+#### `GitBook.ImportCSS`
+
+Import a CSS file by resolving the path correctly according to the current page:
+
+```js
+<GitBook.ImportCSS href="myfile.css" />
+```
+
+#### `GitBook.ImportJS`
+
+Import a JS file by resolving the path correctly according to the current page:
+
+```js
+<GitBook.ImportJS src="mylib.js" />
+```
+
+#### `GitBook.InjectedComponent`
+
+Inject a component matching a specific role:
+
+```js
+<GitBook.InjectedComponent matching={{ role: 'mycustomrole' }} props={{ someProp: 1 }}>
+    <b>Inner content</b>
+</GitBook.InjectedComponent>
+```
+
+#### `GitBook.InjectedComponentSet`
+
+Same API as `InjectedComponentSet` but render the matching components in chain instead of composed:
+
+```js
+<GitBook.InjectedComponentSet matching={{ role: 'mytoolbar' }} />
+```
+
+**Warning:** Children are discarded.
+
+#### `GitBook.FlexLayout` and `GitBook.FlexBox`
+
+A simple wrapper that provides a Flexbox layout with the given direction and style. Any additional props you set on the Flexbox are rendered.
+
+```js
+<GitBook.FlexLayout column>
+    <GitBook.FlexBox>First column</GitBook.FlexBox>
+    <GitBook.FlexBox>Second column</GitBook.FlexBox>
+</GitBook.FlexLayout>
+```

docs/api/connect.md

@@ -0,0 +1,33 @@
+# Connect to the context
+
+`GitBook.connect(Component, [mapStateToProps], [mapActionsToProps])` connects a react component to the GitBook context.
+
+It does not modify the component class passed to it.
+Instead, it returns a new, connected component class, for you to use.
+
+### `mapStateToProps(state, [ownProps]): stateProps`
+
+If specified, the component will subscribe to GitBook store updates. Any time it updates, `mapStateToProps` will be called. Its result must be a plain object, and it will be merged into the component’s props.
+
+If you omit it, the component will not be subscribed to the GitBook store. If `ownProps` is specified as a second argument, its value will be the props passed to your component, and `mapStateToProps` will be additionally re-invoked whenever the component receives new props (e.g. if props received from a parent component have shallowly changed, and you use the `ownProps` argument, `mapStateToProps` is re-evaluated).
+
+For example to render the title of the current page:
+
+```js
+const GitBook = require('gitbook-core');
+
+let PageTitle = React.createClass({
+    render() {
+        const { page } = this.props;
+        return <h1>{page.title}</h1>;
+    }
+});
+
+function mapStateToProps(state) {
+    return { page: state.page };
+}
+
+PageTitle = GitBook.connect(PageTitle, mapStateToProps);
+```
+
+### `mapActionsToProps(actions, [dispatch])`

docs/api/i18n.md

@@ -0,0 +1,44 @@
+# Internationalize your plugin
+
+GitBook has built-in support for internationalization. Plugins can register new languages and provide the right messages for different languages.
+
+### Register locale and messages
+
+The first step is to register messages for a language:
+
+```js
+module.exports = GitBook.createPlugin({
+    init: (dispatch, getState, { I18n }) => {
+        dispatch(I18n.registerLocale('en-US', {
+            MY_PLUGIN_MESSAGE: 'Hello World'
+        }));
+    }
+});
+```
+
+### Render a message in a component
+
+`GitBook.connect` adds a `i18n` prop to access the internationalization:
+
+```js
+const GitBook = require('gitbook-core');
+const { React } = GitBook;
+
+const MyButton = React.createClass({
+    propTypes: {
+        i18n: GitBook.Shapes.i18n
+    },
+
+    render() {
+        const { i18n } = this.props;
+
+        return (
+            <GitBook.Button>
+                {i18.t('MY_PLUGIN_MESSAGE')}
+            </GitBook.Button>
+        );
+    }
+});
+
+module.exports = GitBook.connect(MyButton);
+```

docs/api/navigation.md

@@ -0,0 +1,23 @@
+# Navigation
+
+### Listen to url change
+
+Listen for changes to the current location:
+
+```js
+const onLocationChanged = (location) => {
+    console.log(location.pathname);
+    console.log(location.query);
+    console.log(location.hash);
+};
+
+module.exports = GitBook.createPlugin({
+    init: (dispatch, getState, { Navigation }) => {
+        dispatch(Navigation.listen(onLocationChanged));
+    }
+});
+```
+
+The `onLocationChanged` will be triggered for initial state.
+
+### Changing the url

docs/api/node.md

@@ -0,0 +1,97 @@
+# Node APIs
+
+GitBooks provides different Node APIs and contexts to plugins. These APIs can vary according to the GitBook version being used, your plugin should specify the `engines.gitbook` field in `package.json` accordingly.
+
+#### Book instance
+
+The `Book` interface is the central point of GitBook, it centralize all access read methods.
+
+```js
+// Read configuration from book.json
+var value = book.config.get('title', 'Default Value');
+
+// Resolve a filename to an absolute path
+var filepath = book.resolve('README.md');
+
+// Render an inline markup string
+book.renderInline('markdown', 'This is **Markdown**')
+    .then(function(str) { ... })
+
+// Render a markup string (block mode)
+book.renderBlock('markdown', '* This is **Markdown**')
+    .then(function(str) { ... })
+```
+
+#### Output instance
+
+The `Output` class represent the output/write process.
+
+```js
+// Return root folder for the output
+var root = output.root();
+
+// Resolve a file in the output folder
+var filepath = output.resolve('myimage.png');
+
+// Convert a filename to an URL (returns a path to an html file)
+var fileurl = output.toURL('mychapter/README.md');
+
+// Write a file in the output folder
+output.writeFile('hello.txt', 'Hello World')
+    .then(function() { ... });
+
+// Copy a file to the output folder
+output.copyFile('./myfile.jpg', 'cover.jpg')
+    .then(function() { ... });
+
+// Verify that a file exists
+output.hasFile('hello.txt')
+    .then(function(exists) { ... });
+```
+
+#### Page instance
+
+A page instance represent the current parsed page.
+
+```js
+// Title of the page (from SUMMARY)
+page.title
+
+// Content of the page (Markdown/Asciidoc/HTML according to the stage)
+page.content
+
+// Relative path in the book
+page.path
+
+// Absolute path to the file
+page.rawPath
+
+// Type of parser used for this file
+page.type ('markdown' or 'asciidoc')
+```
+
+#### Context for Blocks and Filters
+
+Blocks and filters have access to the same context, this context is bind to the template engine execution:
+
+```js
+{
+    // Current templating syntax
+    "ctx": {
+        // For example, after a {% set message = "hello" %}
+        "message": "hello"
+    },
+
+    // Book instance
+    "book" <Book>,
+
+    // Output instance
+    "output": <Output>
+}
+```
+
+For example a filter or block function can access the current book using: `this.book`.
+
+#### Context for Hooks
+
+Hooks only have access to the `<Book>` instance using `this.book`.

docs/config.md

@@ -0,0 +1,55 @@
+# Configuration
+
+GitBook allows you to customize your book using a flexible configuration. These options are specified in a `book.json` file. For authors unfamiliar with the JSON syntax, you can validate the syntax using tools such as [JSONlint](http://jsonlint.com).
+
+### General Settings
+
+| Variable | Description |
+| -------- | ----------- |
+| `root` | Path to the root folder containing all the book's files, except `book.json`|
+| `structure` | To specify paths for Readme, Summary, Glossary etc. See [Structure paragraph](#structure). |
+| `title` | Title of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. |
+| `description` | Description of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. |
+| `author` | Name of the author. On GitBook.com this field is pre-filled. |
+| `isbn` | ISBN of the book |
+| `language` | [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the book's language, default value is `en` |
+| `direction` | Text's direction. Can be `rtl` or `ltr`, the default value depends on the value of `language` |
+| `gitbook` | Version of GitBook that should be used. Uses the [SemVer](http://semver.org) specification and accepts conditions like `">= 3.0.0"` |
+
+### Plugins
+
+Plugins and their configurations are specified in the `book.json`. See [the plugins section](plugins/README.md) for more details.
+
+Since version 3.0.0, GitBook can use themes. See [the theming section](themes/README.md) for more details.
+
+| Variable | Description |
+| -------- | ----------- |
+| `plugins` | List of plugins to load |
+| `pluginsConfig` |Configuration for plugins |
+
+### Structure
+
+In addition to the `root` variable, you can tell Gitbook the name of the files for Readme, Summary, Glossary, Languages (instead of using the default names such as `README.md`).
+These files must be at the root of your book (or the root of every language book). Paths such as `dir/MY_README.md` are not accepted.
+
+| Variable | Description |
+| -------- | ----------- |
+| `structure.readme` | Readme file name (defaults to `README.md`) |
+| `structure.summary` | Summary file name (defaults to `SUMMARY.md`) |
+| `structure.glossary` | Glossary file name (defaults to `GLOSSARY.md`) |
+| `structure.languages` | Languages file name (defaults to `LANGS.md`) |
+
+### PDF Options
+
+PDF Output can be customized using a set of options in the `book.json`:
+
+| Variable | Description |
+| -------- | ----------- |
+| `pdf.pageNumbers` | Add page numbers to the bottom of every page (default is `true`) |
+| `pdf.fontSize` | Base font size (default is `12`) |
+| `pdf.fontFamily` | Base font family (default is `Arial`) |
+| `pdf.paperSize` | Paper size, options are `'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'legal', 'letter'` (default is `a4`) |
+| `pdf.margin.top` | Top margin (default is `56`) |
+| `pdf.margin.bottom` | Bottom margin (default is `56`) |
+| `pdf.margin.right` | Right margin (default is `62`) |
+| `pdf.margin.left` | Left margin (default is `62`) |

docs/ebook.md

@@ -0,0 +1,55 @@
+# Generating eBooks and PDFs
+
+GitBook can generates a website, but can also output content as ebook (ePub, Mobi, PDF).
+
+```
+# Generate a PDF file
+$ gitbook pdf ./ ./mybook.pdf
+
+# Generate an ePub file
+$ gitbook epub ./ ./mybook.epub
+
+# Generate a Mobi file
+$ gitbook mobi ./ ./mybook.mobi
+```
+
+### Installing ebook-convert
+
+`ebook-convert` is required to generate ebooks (epub, mobi, pdf).
+
+##### GNU/Linux
+
+Install the [Calibre application](https://calibre-ebook.com/download).
+
+```
+$ sudo aptitude install calibre
+```
+
+In some GNU/Linux distributions node is installed as nodejs, you need to manually create a symlink:
+
+```
+$sudo ln -s /usr/bin/nodejs /usr/bin/node
+```
+
+##### OS X
+
+Download the [Calibre application](https://calibre-ebook.com/download). After moving the `calibre.app` to your Applications folder create a symbolic link to the ebook-convert tool:
+
+```
+$ sudo ln -s ~/Applications/calibre.app/Contents/MacOS/ebook-convert /usr/bin
+```
+
+You can replace `/usr/bin` with any directory that is in your $PATH.
+
+### Cover
+
+Covers are used for all the ebook formats. You can either provide one yourself, or generate one using the [autocover plugin](https://plugins.gitbook.com/plugin/autocover).
+
+To provide a cover, place a **`cover.jpg`** file at the root directory of your book. Adding a **`cover_small.jpg`** will specify a smaller version of the cover. The cover should be a **JPEG** file.
+
+A good cover should respect the following guidelines:
+
+* Size of 1800x2360 pixels for `cover.jpg`, 200x262 for `cover_small.jpg`
+* No border
+* Clearly visible book title
+* Any important text should be visible in the small version

docs/examples.md

@@ -0,0 +1,28 @@
+---
+description: Real world examples of content published using GitBook.
+---
+
+# Examples
+
+More than 50,000 books have been published on [GitBook.com](https://www.gitbook.com/explore).
+
+### Books
+
+- [Front-end Handbook](https://www.gitbook.com/book/frontendmasters/front-end-handbook/details) by [Cody Lindley](http://codylindley.com)
+- [How to make an Operating System](https://www.gitbook.com/book/samypesse/how-to-create-an-operating-system/details) by [@SamyPesse](https://github.com/SamyPesse)
+- [Building Web Apps with Go](https://www.gitbook.com/book/codegangsta/building-web-apps-with-go/details) by [@codegangsta](https://github.com/codegangsta)
+- [Django Girls Tutorial](http://tutorial.djangogirls.org/en/index.html) by [Django Girls](https://djangogirls.org)
+- [Linux Inside](https://www.gitbook.com/book/0xax/linux-insides/details) by [0xAX](https://twitter.com/0xAX)
+- [Learn Javascript](https://www.gitbook.com/book/gitbookio/javascript/details) by [GitBook](https://twitter.com/GitbookIO)
+
+### Research Papers
+
+- [TowCenter Collection](https://www.gitbook.com/@towcenter) by [Columbia Journalism School](http://www.journalism.columbia.edu/)
+- [Block Relaxation Algorithms in Statistics](https://www.gitbook.com/@jandeleeuw) by Jan de Leeuw
+
+### Documentation
+
+- [DuckDuckHack Documentation](http://docs.duckduckhack.com) by [DuckDuckGo](https://duckduckgo.com/about)
+- [Loomio Handbook](http://loomio.coop/) and [guide to using Loomio](https://loomio.gitbooks.io/manual/content/en/index.html) both by [Loomio](https://www.loomio.org/)
+- [Enspiral Handbook](http://handbook.enspiral.com/) by [Enspiral](http://enspiral.com/)
+- This documentation

docs/faq.md

@@ -0,0 +1,55 @@
+# GitBook FAQ
+
+This page gathers common questions and answers concerning the GitBook format and toolchain.
+
+Questions about GitBook.com and the Editor are gather into the [help.gitbook.com's FAQ](http://help.gitbook.com/faq.html).
+
+#### How can I host/publish my book?
+
+Books can easily be published and hosted on [GitBook.com](https://www.gitbook.com). But GitBook output can be hosted on any static file hosting solution.
+
+#### What can I use to edit my content?
+
+Any text editor should work! But we advise using the [GitBook Editor](https://www.gitbook.com/editor). [GitBook.com](https://www.gitbook.com) also provides a web version of this editor.
+
+---
+
+#### Does GitBook supports RTL/bi-directional text ?
+
+The GitBook format supports right to left, and bi-directional writing. To enable it, you either need to specify a language (ex: `ar`), or force GitBook to use RTL in your `book.json`:
+
+```json
+{
+    "language": "ar",
+    "direction": "rtl"
+}
+```
+
+With version 3.0 of GitBook, it's automatically detected according to the content.
+_Note that, while the output book will indeed respect RTL, the Editor doesn't support RTL writing yet_.
+
+#### Should I use an `.html` or `.md` extensions in my links?
+
+You should always use paths and the `.md` extensions when linking to your files, GitBook will automatically replace these paths by the appropriate link when the pointing file is referenced in the Table of Contents.
+
+#### Can I create a GitBook in a sub-directory of my repository?
+
+Yes, GitBooks can be created in [sub-directories](structure.md#subdirectory). GitBook.com and the CLI also looks by default in a series of [folders](structure.md).
+
+#### Does GitBook supports RTL languages?
+
+Yes, GitBook automatically detect the direction in your pages (`rtl` or `ltr`) and adjust the layout accordingly. The direction can also be specified globally in the [book.json](config.md).
+
+---
+
+#### Does GitBook support Math equations?
+
+GitBook supports math equations and TeX thanks to plugins. There are currently 2 official plugins to display math: [mathjax](https://plugins.gitbook.com/plugin/mathjax) and [katex](https://plugins.gitbook.com/plugin/katex).
+
+#### Can I customize/theme the output?
+
+Yes, both the website and ebook outputs can be customized using [themes](themes/README.md).
+
+#### Can I add interactive content (videos, etc)?
+
+GitBook is very [extensible](plugins/README.md). You can use [existing plugins](https://plugins.gitbook.com) or create your own!

docs/languages.md

@@ -0,0 +1,17 @@
+# Multi-Languages
+
+GitBook supports building books written in multiple languages. Each language should be a sub-directory following the normal GitBook format, and a file named `LANGS.md` should be present at the root of the repository with the following format:
+
+```markdown
+# Languages
+
+* [English](en/)
+* [French](fr/)
+* [Español](es/)
+```
+
+### Configuration for each language
+
+When a language book (ex: `en`) has a `book.json`, its configuration will extend the main configuration.
+
+The only exception is plugins, plugins are specified globally, and language specific plugins cannot be specified.

docs/lexicon.md

@@ -0,0 +1,14 @@
+# Glossary
+
+Allows you to specify terms and their respective definitions to be displayed as annotations. Based on those terms, GitBook will automatically build an index and highlight those terms in pages.
+
+The `GLOSSARY.md` format is a list of `h2` headings, along with a description paragraph:
+
+```markdown
+## Term
+Definition for this term
+
+## Another term
+With it's definition, this can contain bold text
+and all other kinds of inline markup ...
+```

docs/pages.md

@@ -0,0 +1,103 @@
+# Pages and Summary
+
+### Summary
+
+GitBook uses a `SUMMARY.md` file to define the structure of chapters and subchapters of the book. The `SUMMARY.md` file is used to generate the book's table of contents.
+
+The format of `SUMMARY.md` is just a list of links. The link's title is used as the chapter's title, and the link's target is a path to that chapter's file.
+
+Adding a nested list to a parent chapter will create subchapters.
+
+##### Simple example
+
+```markdown
+# Summary
+
+* [Part I](part1/README.md)
+    * [Writing is nice](part1/writing.md)
+    * [GitBook is nice](part1/gitbook.md)
+* [Part II](part2/README.md)
+    * [We love feedback](part2/feedback_please.md)
+    * [Better tools for authors](part2/better_tools.md)
+```
+
+Each chapter has a dedicated page (`part#/README.md`) and is split into subchapters.
+
+##### Anchors
+
+Chapters in the Table of Contents can be pointing to specific part of a file using anchor.
+
+```markdown
+# Summary
+
+### Part I
+
+* [Part I](part1/README.md)
+    * [Writing is nice](part1/README.md#writing)
+    * [GitBook is nice](part1/README.md#gitbook)
+* [Part II](part2/README.md)
+    * [We love feedback](part2/README.md#feedback)
+    * [Better tools for authors](part2/README.md#tools)
+```
+
+##### Parts
+
+The Table of Contents can be divided into parts separated by headings or horizontal lines:
+
+```markdown
+# Summary
+
+### Part I
+
+* [Writing is nice](part1/writing.md)
+* [GitBook is nice](part1/gitbook.md)
+
+### Part II
+
+* [We love feedback](part2/feedback_please.md)
+* [Better tools for authors](part2/better_tools.md)
+
+----
+
+* [Last part without title](part3/title.md)
+```
+
+Parts are just groups of chapters and do not have dedicated pages, but according to the theme, it will show in the navigation.
+
+### Pages
+
+#### Markdown syntax
+
+Most of the files for GitBook use the Markdown syntax by default. GitBook infers your pages's structure from it. The syntax used is similar to the [GitHub Flavored Markdown syntax](https://guides.github.com/features/mastering-markdown/). One can also opt for the [AsciiDoc syntax](asciidoc.md).
+
+##### Example of a chapter file
+
+```markdown
+# Title of the chapter
+
+This is a great introduction.
+
+## Section 1
+
+Markdown will dictates _most_ of your **book's structure**
+
+## Section 2
+
+...
+
+```
+
+#### Front Matter
+
+Pages can contain an optional front matter. It can be used to define the page's description. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:
+
+```yaml
+---
+description: This is a short description of my page
+---
+
+# The content of my page
+...
+```
+
+The front matter can define variables of your own, they will be added to the [page variable](templating/variables.md) so you can use them in your templating.

docs/plugins/README.md

@@ -0,0 +1,28 @@
+# 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 Analytics, 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.
+
+### GitBook.com
+
+Plugins are automatically installed on [GitBook.com](https://www.gitbook.com). Locally, run `gitbook install` to install and prepare all plugins for your books.
+
+### Configuring plugins
+
+Plugins specific configurations are stored in `pluginsConfig`. You have to refer to the documentation of the plugin itself for details about the available options.

docs/plugins/api.md

@@ -0,0 +1,97 @@
+# Context and APIs
+
+GitBooks provides different APIs and contexts to plugins. These APIs can vary according to the GitBook version being used, your plugin should specify the `engines.gitbook` field in `package.json` accordingly.
+
+#### Book instance
+
+The `Book` class is the central point of GitBook, it centralize all access read methods. This class is defined in [book.js](https://github.com/GitbookIO/gitbook/blob/master/book.js).
+
+```js
+// Read configuration from book.json
+var value = book.config.get('title', 'Default Value');
+
+// Resolve a filename to an absolute path
+var filepath = book.resolve('README.md');
+
+// Render an inline markup string
+book.renderInline('markdown', 'This is **Markdown**')
+    .then(function(str) { ... })
+
+// Render a markup string (block mode)
+book.renderBlock('markdown', '* This is **Markdown**')
+    .then(function(str) { ... })
+```
+
+#### Output instance
+
+The `Output` class represent the output/write process.
+
+```js
+// Return root folder for the output
+var root = output.root();
+
+// Resolve a file in the output folder
+var filepath = output.resolve('myimage.png');
+
+// Convert a filename to an URL (returns a path to an html file)
+var fileurl = output.toURL('mychapter/README.md');
+
+// Write a file in the output folder
+output.writeFile('hello.txt', 'Hello World')
+    .then(function() { ... });
+
+// Copy a file to the output folder
+output.copyFile('./myfile.jpg', 'cover.jpg')
+    .then(function() { ... });
+
+// Verify that a file exists
+output.hasFile('hello.txt')
+    .then(function(exists) { ... });
+```
+
+#### Page instance
+
+A page instance represent the current parsed page.
+
+```js
+// Title of the page (from SUMMARY)
+page.title
+
+// Content of the page (Markdown/Asciidoc/HTML according to the stage)
+page.content
+
+// Relative path in the book
+page.path
+
+// Absolute path to the file
+page.rawPath
+
+// Type of parser used for this file
+page.type ('markdown' or 'asciidoc')
+```
+
+#### Context for Blocks and Filters
+
+Blocks and filters have access to the same context, this context is bind to the template engine execution:
+
+```js
+{
+    // Current templating syntax
+    "ctx": {
+        // For example, after a {% set message = "hello" %}
+        "message": "hello"
+    },
+
+    // Book instance
+    "book" <Book>,
+
+    // Output instance
+    "output": <Output>
+}
+```
+
+For example a filter or block function can access the current book using: `this.book`.
+
+#### Context for Hooks
+
+Hooks only have access to the `<Book>` instance using `this.book`.

docs/plugins/blocks.md

@@ -0,0 +1,62 @@
+# Extend Blocks
+
+Extending templating blocks is the best way to provide extra functionalities to authors.
+
+The most common usage is to process the content within some tags at runtime. It's like [filters](./filters.md), but on steroids because you aren't confined to a single expression.
+
+### Defining a new block
+
+Blocks are defined by the plugin, blocks is a map of name associated with a block descriptor. The block descriptor needs to contain at least a `process` method.
+
+```js
+module.exports = {
+    blocks: {
+        tag1: {
+            process: function(block) {
+                return "Hello "+block.body+", How are you?";
+            }
+        }
+    }
+};
+```
+
+The `process` should return the html content that will replace the tag. Refer to [Context and APIs](./api.md) to learn more about `this` and GitBook API.
+
+### Handling block arguments
+
+Arguments can be passed to blocks:
+
+```
+{% tag1 "argument 1", "argument 2", name="Test" %}
+This is the body of the block.
+{% endtag1 %}
+```
+
+And arguments are easily accessible in the `process` method:
+
+```js
+module.exports = {
+    blocks: {
+        tag1: {
+            process: function(block) {
+                // block.args equals ["argument 1", "argument 2"]
+                // block.kwargs equals { "name": "Test" }
+            }
+        }
+    }
+};
+```
+
+### Handling sub-blocks
+
+A defined block can be parsed into different sub-blocks, for example let's consider the source:
+
+```
+{% myTag %}
+    Main body
+    {% subblock1 %}
+    Body of sub-block 1
+    {% subblock 2 %}
+    Body of sub-block 1
+{% endmyTag %}
+```

docs/plugins/create.md

@@ -0,0 +1,74 @@
+# Create and publish a plugin
+
+A GitBook plugin is a node package published on NPM that follow a defined convention.
+
+## Structure
+
+#### package.json
+
+The `package.json` is a manifest format for describing **Node.js modules**. GitBook plugins are built on top of Node modules. It declares dependencies, version, ownership, and other information required to run a plugin in GitBook. This document describes the schema in detail.
+
+A plugin manifest `package.json` can also contain details about the required configuration. The configuration schema is defined in the `gitbook` field of the `package.json` (This field follow the [JSON-Schema](http://json-schema.org) guidelines):
+
+```js
+{
+    "name": "gitbook-plugin-mytest",
+    "version": "0.0.1",
+    "description": "This is my first GitBook plugin",
+    "engines": {
+        "gitbook": ">1.x.x"
+    },
+    "gitbook": {
+        "properties": {
+            "myConfigKey": {
+                "type": "string",
+                "default": "it's the default value",
+                "description": "It defines my awesome config!"
+            }
+        }
+    }
+}
+```
+
+You can learn more about `package.json` from the [NPM documentation](https://docs.npmjs.com/files/package.json).
+
+The **package name** must begin with `gitbook-plugin-` and the **package engines** should contains `gitbook`.
+
+#### index.js
+
+The `index.js` is main entry point of your plugin runtime:
+
+```js
+module.exports = {
+    // Map of hooks
+    hooks: {},
+
+    // Map of new blocks
+    blocks: {},
+
+    // Map of new filters
+    filters: {}
+};
+```
+
+## Publish your plugin
+
+GitBook plugins can be published on [NPM](https://www.npmjs.com).
+
+To publish a new plugin, you need to create an account on [npmjs.com](https://www.npmjs.com) then publish it from the command line:
+
+```
+$ npm publish
+```
+
+## Private plugins
+
+Private plugins can be hosted on GitHub and included using `git` urls:
+
+```
+{
+    "plugins": [
+        "myplugin@git+https://github.com/MyCompany/mygitbookplugin.git#1.0.0"
+    ]
+}
+```

docs/plugins/filters.md

@@ -0,0 +1,57 @@
+# Extend Filters
+
+Filters are essentially functions that can be applied to variables. They are called with a pipe operator (`|`) and can take arguments.
+
+```
+{{ foo | title }}
+{{ foo | join(",") }}
+{{ foo | replace("foo", "bar") | capitalize }}
+```
+
+### Defining a new filter
+
+Plugins can extend filters by defining custom functions in their entry point under the `filters` scope.
+
+A filter function takes as first argument the content to filter, and should return the new content.
+Refer to [Context and APIs](./api.md) to learn more about `this` and GitBook API.
+
+```js
+module.exports = {
+    filters: {
+        hello: function(name) {
+            return 'Hello '+name;
+        }
+    }
+};
+```
+
+The filter `hello` can then be used in the book:
+
+```
+{{ "Aaron"|hello }}, how are you?
+```
+
+### Handling block arguments
+
+Arguments can be passed to filters:
+
+```
+Hello {{ "Samy"|fullName("Pesse", man=true}} }}
+```
+
+Arguments are passed to the function, named-arguments are passed as a last argument (object).
+
+```js
+module.exports = {
+    filters: {
+        fullName: function(firstName, lastName, kwargs) {
+            var name = firstName + ' ' + lastName;
+
+            if (kwargs.man) name = "Mr" + name;
+            else name = "Mrs" + name;
+
+            return name;
+        }
+    }
+};
+```

docs/plugins/hooks.md

@@ -0,0 +1,89 @@
+# Hooks
+
+Hooks is a method of augmenting or altering the behavior of the process, with custom callbacks.
+
+### List of hooks
+
+### Relative to the global pipeline
+
+| Name | Description | Arguments |
+| ---- | ----------- | --------- |
+| `init` | Called after parsing the book, before generating output and pages. | None |
+| `finish:before` | Called after generating the pages, before copying assets, cover, ... | None |
+| `finish` | Called after everything else. | None |
+
+### Relative to the page pipeline
+
+> It is recommended using [templating](./templating.md) to extend page parsing.
+
+| Name | Description | Arguments |
+| ---- | ----------- | --------- |
+| `page:before` | Called before running the templating engine on the page | Page Object |
+| `page` | Called before outputting and indexing the page. | Page Object |
+
+##### Page Object
+
+```js
+{
+    // Parser named
+    "type": "markdown",
+
+    // File Path relative to book root
+    "path": "page.md",
+
+    // Absolute file path
+    "rawpath": "/usr/...",
+
+    // Title of the page in the SUMMARY
+    "title": "",
+
+    // Content of the page
+    // Markdown/Asciidoc in "page:before"
+    // HTML in "page"
+    "content": "# Hello"
+}
+```
+
+##### Example to add a title
+
+In the `page:before` hook, `page.content` is the markdown/asciidoc content.
+
+```js
+{
+    "page:before": function(page) {
+        page.content = "# Title\n" +page.content;
+        return page;
+    }
+}
+```
+
+##### Example to replace some html
+
+In the `page` hook, `page.content` is the HTML generated from the markdown/asciidoc conversion.
+
+```js
+{
+    "page": function(page) {
+        page.content = page.content.replace("<b>", "<strong>")
+            .replace("</b>", "</strong>");
+        return page;
+    }
+}
+```
+
+### Asynchronous Operations
+
+Hooks callbacks can be asynchronous and return promises.
+
+Example:
+
+```js
+{
+    "init": function() {
+        return writeSomeFile()
+        .then(function() {
+            return writeAnotherFile();
+        });
+    }
+}
+```

docs/plugins/testing.md

@@ -0,0 +1,21 @@
+# Testing your plugin
+
+### Testing your plugin locally
+
+Testing your plugin on your book before publishing it is possible using [npm link](https://docs.npmjs.com/cli/link).
+
+In the plugin's folder, run:
+
+```
+$ npm link
+```
+
+Then in your book's folder:
+
+```
+$ npm link gitbook-plugin-<plugin's name>
+```
+
+### Unit testing on Travis
+
+[gitbook-tester](https://github.com/todvora/gitbook-tester) makes it easy to write **Node.js/Mocha** unit tests for your plugins. Using [Travis.org](https://travis.org), tests can be run on each commits/tags.

docs/setup.md

@@ -0,0 +1,68 @@
+# Setup and Installation of GitBook
+
+Getting GitBook installed and ready-to-go should only take a few minutes.
+
+### GitBook.com
+
+[GitBook.com](https://www.gitbook.com) is an easy to use solution to write, publish and host books. It is the easiest solution for publishing your content and collaborating on it.
+
+It integrates well with the [GitBook Editor](https://www.gitbook.com/editor).
+
+### Local Installation
+
+##### Requirements
+
+Installing GitBook is easy and straightforward. Your system just needs to meet these two requirements:
+
+* NodeJS (v4.0.0 and above is recommended)
+* Windows, Linux, Unix, or Mac OS X
+
+##### Install with NPM
+
+The best way to install GitBook is via **NPM**. At the terminal prompt, simply run the following command to install GitBook:
+
+```
+$ npm install gitbook-cli -g
+```
+
+`gitbook-cli` is an utility to install and use multiple versions of GitBook on the same system. It will automatically install the required version of GitBook to build a book.
+
+##### Create a book
+
+GitBook can setup a boilerplate book:
+
+```
+$ gitbook init
+```
+
+If you wish to create the book into a new directory, you can do so by running `gitbook init ./directory`
+
+Preview and serve your book using:
+
+```
+$ gitbook serve
+```
+
+Or build the static website using:
+
+```
+$ gitbook build
+```
+
+##### Install pre-releases
+
+`gitbook-cli` makes it easy to download and install other versions of GitBook to test with your book:
+
+```
+$ gitbook fetch beta
+```
+
+Use `gitbook ls-remote` to list remote versions available for install.
+
+##### Debugging
+
+You can use the options `--log=debug` and `--debug` to get better error messages (with stack trace). For example:
+
+```
+$ gitbook build ./ --log=debug --debug
+```

docs/structure.md

@@ -0,0 +1,66 @@
+# Directory Structure
+
+GitBook uses a simple directory structure. All Markdown/Asciidoc files listed in the [SUMMARY](pages.md) will be transformed as HTML. Multi-Lingual books have a slightly [different structure](languages.md).
+
+A basic GitBook usually looks something like this:
+
+```
+.
+├── book.json
+├── README.md
+├── SUMMARY.md
+├── chapter-1/
+|   ├── README.md
+|   └── something.md
+└── chapter-2/
+    ├── README.md
+    └── something.md
+```
+
+An overview of what each of these does:
+
+| File | Description |
+| -------- | ----------- |
+| `book.json` | Stores [configuration](config.md) data (__optional__) |
+| `README.md` | Preface / Introduction for your book (**required**) |
+| `SUMMARY.md` | Table of Contents (See [Pages](pages.md)) (__optional__) |
+| `GLOSSARY.md` | Lexicon / List of terms to annotate (See [Glossary](lexicon.md)) (__optional__) |
+
+### Static files and Images
+
+A static file is a file that is not listed in the `SUMMARY.md`. All static files, unless [ignored](#ignore), are copied to the output.
+
+### Ignoring files & folders {#ignore}
+
+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`:
+
+```
+# This is a comment
+
+# Ignore the file test.md
+test.md
+
+# Ignore everything in the directory "bin"
+bin/*
+```
+
+### Project integration with subdirectory {#subdirectory}
+
+For software projects, you can use a subdirectory (like `docs/`) to store the book for the project's documentation. You can configure the [`root` option](config.md) to indicate the folder where GitBook can find the book's files:
+
+```
+.
+├── book.json
+└── docs/
+    ├── README.md
+    └── SUMMARY.md
+```
+
+With `book.json` containing:
+
+```
+{
+    "root": "./docs"
+}
+```

docs/styles/website.css

@@ -0,0 +1,4 @@
+/* Reduce size of logo to allow long versions like 3.0.0-pre.1 */
+.gb-page-header .container .logo h1 {
+    font-size: 24px ;
+}

docs/syntax/asciidoc.md

@@ -0,0 +1,64 @@
+# AsciiDoc
+
+Since version `2.0.0`, GitBook can also accept AsciiDoc as an input format.
+
+Please refer to the [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/) for more informations about the format.
+
+Just like for markdown, GitBook is using some special files to extract structures: `README.adoc`, `SUMMARY.adoc`, `LANGS.adoc` and `GLOSSARY.adoc`.
+
+### README.adoc
+
+This is the main entry of your book: the introduction. This file is **required**.
+
+### SUMMARY.adoc
+
+This file defines the list of chapters and subchapters. Just like in Markdown, the `SUMMARY.adoc`'s format is simply a list of links, the name of the link is used as the chapter's name, and the target is a path to that chapter's file.
+
+Subchapters are defined simply by adding a nested list to a parent chapter.
+
+```asciidoc
+= Summary
+
+. link:chapter-1/README.adoc[Chapter 1]
+.. link:chapter-1/ARTICLE1.adoc[Article 1]
+.. link:chapter-1/ARTICLE2.adoc[Article 2]
+... link:chapter-1/ARTICLE-1-2-1.adoc[Article 1.2.1]
+. link:chapter-2/README.adoc[Chapter 2]
+. link:chapter-3/README.adoc[Chapter 3]
+. link:chapter-4/README.adoc[Chapter 4]
+.. Unfinished article
+. Unfinished Chapter
+```
+
+### LANGS.adoc
+
+For [Multi-Languages](./languages.md) books, this file is used to define the different supported languages and translations.
+
+This file is following the same syntax as the `SUMMARY.adoc`:
+
+```asciidoc
+= Languages
+
+. link:en/[English]
+. link:fr/[French]
+```
+
+### GLOSSARY.adoc
+
+This file is used to define terms. [See the glossary section](./lexicon.md).
+
+```asciidoc
+= Glossary
+
+== Magic
+
+Sufficiently advanced technology, beyond the understanding of the
+observer producing a sense of wonder.
+
+== PHP
+
+A popular web programming language, used by many large websites such
+as Facebook. Rasmus Lerdorf originally created PHP in 1994 to power
+his personal homepage (PHP originally stood for "Personal Home Page"
+but now stands for "PHP: Hypertext Preprocessor").
+```

docs/syntax/markdown.md

@@ -0,0 +1,223 @@
+# Markdown
+
+Most of the examples from this documentation are in Markdown. Markdown is default parser for GitBook, but one can also opt for the [AsciiDoc syntax](asciidoc.md).
+
+Here’s an overview of Markdown syntax that you can use with GitBook (same as GitHub with some additions).
+
+### Headings
+
+To create a heading, add one to six `#` symbols before your heading text. The number of # you use will determine the size of the heading.
+
+```markdown
+# This is an <h1> tag
+## This is an <h2> tag
+###### This is an <h6> tag
+```
+
+GitBook supports a nice way for explicitly setting the header ID. If you follow the header text with an opening curly bracket (separated from the text with a least one space), a hash, the ID and a closing curly bracket, the ID is set on the header. If you use the trailing hash feature of atx style headers, the header ID has to go after the trailing hashes. For example:
+
+```markdown
+Hello {#id}
+-----
+
+# Hello {#id}
+
+# Hello # {#id}
+```
+
+### Paragraphs and Line Breaks {#paragraphs}
+
+A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines. (A blank line is any line that looks like a blank line — a line containing nothing but spaces or tabs is considered blank.) Normal paragraphs should not be indented with spaces or tabs.
+
+```
+Here's a line for us to start with.
+
+This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
+```
+
+### Emphasis {#emphasis}
+
+```markdown
+*This text will be italic*
+_This will also be italic_
+
+**This text will be bold**
+__This will also be bold__
+
+~~This text will be crossed out.~~
+
+_You **can** combine them_
+```
+
+### Lists {#lists}
+
+Markdown supports ordered (numbered) and unordered (bulleted) lists.
+
+##### Unordered
+
+Unordered lists use asterisks, pluses, and hyphens — interchangably — as list markers:
+
+```markdown
+* Item 1
+* Item 2
+  * Item 2a
+  * Item 2b
+```
+
+##### Ordered
+
+Ordered lists use numbers followed by periods:
+
+```markdown
+1. Item 1
+2. Item 2
+3. Item 3
+   * Item 3a
+   * Item 3b
+```
+
+### Links {#links}
+
+Markdown supports two style of links: inline and reference.
+
+A simple link can be created by surrounding the text with square brackets and the link URL with parentheses:
+
+```markdown
+This is [an example](http://example.com/ "Title") inline link with a title.
+
+[This link](http://example.net/) has no title attribute.
+```
+
+Links can point to relative paths, anchors or absolute urls.
+
+
+### References
+
+There is another way to create links which does not interrupt the text flow. The URL and title are defined using a reference name and this reference name is then used in square brackets instead of the link URL:
+
+```markdown
+This is [an example][id] reference-style link.
+```
+
+Then, anywhere in the document, you define your link label like this, on a line by itself:
+
+```markdown
+[id]: http://example.com/  "Optional Title Here"
+```
+
+### Images {#images}
+
+Images can be created in a similar way than links: just use an exclamation mark before the square brackets. The link text will become the alternative text of the image and the link URL specifies the image source:
+
+```markdown
+An image: ![gras](img/image.jpg)
+```
+
+### Blockquotes {#blockquotes}
+
+A blockquote is started using the `>` marker followed by an optional space; all following lines that are also started with the blockquote marker belong to the blockquote. You can use any block-level elements inside a blockquote:
+
+```markdown
+As Kanye West said:
+
+> We're living the future so
+> the present is our past.
+```
+
+### Tables {#tables}
+
+You can create tables by assembling a list of words and dividing them with hyphens `-` (for the first row), and then separating each column with a pipe `|`:
+
+```markdown
+| First Header  | Second Header |
+| ------------- | ------------- |
+| Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  |
+```
+
+The pipes on either end of the table are optional. Cells can vary in width and do not need to be perfectly aligned within columns. There must be at least three hyphens in each column of the header row.
+
+### Code {#code}
+
+Markdown supports two different code block styles. One uses lines indented with either four spaces or one tab whereas the other uses lines with tilde characters as delimiters – therefore the content does not need to be indented:
+
+```markdown
+This is a sample code block.
+
+    Continued here.
+
+```
+
+##### Fenced code blocks
+
+You can create fenced code blocks by placing triple backticks ` ``` ` before and after the code block. We recommend placing a blank line before and after code blocks to make the raw formatting easier to read.
+
+    ```
+    function test() {
+      console.log("notice the blank line before this function?");
+    }
+    ```
+
+##### Syntax highlighting
+
+You can add an optional language identifier to enable syntax highlighting in your fenced code block.
+
+For example, to syntax highlight Ruby code:
+
+    ```ruby
+    require 'redcarpet'
+    markdown = Redcarpet.new("Hello World!")
+    puts markdown.to_html
+    ```
+
+##### Inline code
+
+Text phrases can be marked up as code by surrounding them with backticks:
+
+    Use `gitbook` to convert the `text` in markdown
+    syntax to HTML.
+
+### Footnotes
+
+GitBook supports a simple syntax for such footnotes. Footnotes are relative to each pages.
+
+```markdown
+Text prior to footnote reference.[^2]
+
+[^2]: Comment to include in footnote.
+```
+
+### HTML
+
+GitBook supports use of raw HTML in your text, Markdown syntax in HTML is not processed:
+
+```
+<div>
+Markdown here will not be **parsed**
+</div>
+```
+
+### Horizontal Rule
+
+Horizontal Rules can be inserted using three or more asterisks, dashes or underscores, optionally separated by spaces or tabs, on an otherwise blank line:
+
+```markdown
+Three or more...
+
+---
+
+Hyphens
+
+***
+
+Asterisks
+
+```
+
+### Ignoring Markdown formatting
+
+You can tell GitBook to ignore (or escape) Markdown formatting by using `\` before the Markdown character.
+
+```
+Let's rename \*our-new-project\* to \*our-old-project\*.
+```

docs/templating/README.md

@@ -0,0 +1,99 @@
+# Templating
+
+GitBook uses the [Nunjucks templating language](https://mozilla.github.io/nunjucks/) to process pages and theme's templates.
+
+The Nunjucks syntax is very similar to **Jinja2** or **Liquid**. Its syntax uses surrounding braces `{ }` to mark content that needs to be processed.
+
+### Variables
+
+A variable looks up a value from the template context. If you wanted to simply display a variable, you would use the `{{ variable }}` syntax. For example :
+
+```twig
+My name is {{ name }}, nice to meet you
+```
+
+This looks up username from the context and displays it. Variable names can have dots in them which lookup properties, just like JavaScript. You can also use the square bracket syntax.
+
+```twig
+{{ foo.bar }}
+{{ foo["bar"] }}
+```
+
+If a value is undefined, nothing is displayed. The following all output nothing if foo is undefined: `{{ foo }}`, `{{ foo.bar }}`, `{{ foo.bar.baz }}`.
+
+GitBook provides a set of [predefined variables](variables.md) from the context.
+
+### Filters
+
+Filters are essentially functions that can be applied to variables. They are called with a pipe operator (`|`) and can take arguments.
+
+```twig
+{{ foo | title }}
+{{ foo | join(",") }}
+{{ foo | replace("foo", "bar") | capitalize }}
+```
+
+The third example shows how you can chain filters. It would display "Bar", by first replacing "foo" with "bar" and then capitalizing it.
+
+### Tags
+
+##### if
+
+`if` tests a condition and lets you selectively display content. It behaves exactly as JavaScript's `if` behaves.
+
+```twig
+{% if variable %}
+  It is true
+{% endif %}
+```
+
+If variable is defined and evaluates to true, "It is true" will be displayed. Otherwise, nothing will be.
+
+You can specify alternate conditions with `elif` and `else`:
+
+```twig
+{% if hungry %}
+  I am hungry
+{% elif tired %}
+  I am tired
+{% else %}
+  I am good!
+{% endif %}
+```
+
+##### for
+
+`for` iterates over arrays and dictionaries.
+
+```twig
+# Chapters about GitBook
+
+{% for article in glossary.terms['gitbook'].articles %}
+* [{{ article.title }}]({{ article.path }})
+{% endfor %}
+```
+
+##### set
+
+`set` lets you create/modify a variable.
+
+```twig
+{% set softwareVersion = "1.0.0" %}
+
+Current version is {{ softwareVersion }}.
+[Download it](website.com/download/{{ softwareVersion }})
+```
+
+##### include and block
+
+Inclusion and inheritance is detailled in the [Content References](conrefs.md) section.
+
+### Escaping
+
+If you want GitBook to ignore any of the special templating tags, you can use raw and anything inside of it will be output as plain text.
+
+```twig
+{% raw %}
+  this will {{ not be processed }}
+{% endraw %}
+```

docs/templating/builtin.md

@@ -0,0 +1,19 @@
+# Builtin Templating Helpers
+
+GitBook provides a serie of builtin filters and blocks to help you write templates.
+
+### Filters
+
+`value|default(default, [boolean])`
+If value is strictly undefined, return default, otherwise value. If boolean is true, any JavaScript falsy value will return default (false, "", etc)
+
+`arr|sort(reverse, caseSens, attr)`
+Sort arr with JavaScript's arr.sort function. If reverse is true, result will be reversed. Sort is case-insensitive by default, but setting caseSens to true makes it case-sensitive. If attr is passed, will compare attr from each item.
+
+### Blocks
+
+`{% markdown %}Markdown string{% endmarkdown %}`
+Render inline markdown
+
+`{% asciidoc %}AsciiDoc string{% endasciidoc %}`
+Render inline asciidoc

docs/templating/conrefs.md

@@ -0,0 +1,55 @@
+# Content References
+
+Content referencing (conref) is a convenient mechanism to reuse content from other files or books.
+
+### Importing local files
+
+Importing an other file's content is easy using the `include` tag:
+
+```
+{% include "./test.md" %}
+```
+
+### Importing file from another book
+
+GitBook can also resolve the include path by using git:
+
+```
+{% include "git+https://github.com/GitbookIO/documentation.git/README.md#0.0.1" %}
+```
+
+The format of git url is:
+
+```
+git+https://user@hostname/owner/project.git/file#commit-ish
+```
+
+The real git url part should finish with `.git`, the filename to import is extracted after the `.git` till the fragment of the url.
+
+The `commit-ish` can be any tag, sha, or branch which can be supplied as an argument to `git checkout`. The default is `master`.
+
+### Inheritance
+
+Template inheritance is a way to make it easy to reuse templates. When writing a template, you can define "blocks" that child templates can override. The inheritance chain can be as long as you like.
+
+`block` defines a section on the template and identifies it with a name. Base templates can specify blocks and child templates can override them with new content.
+
+```
+{% extends "./mypage.md" %}
+
+{% block pageContent %}
+# This is my page content
+{% endblock %}
+```
+
+In the file `mypage.md`, you should specify the blocks that can be extended:
+
+```
+{% block pageContent %}
+This is the default content
+{% endblock %}
+
+# License
+
+{% include "./LICENSE" %}
+```

docs/templating/variables.md

@@ -0,0 +1,98 @@
+# Variables
+
+The following is a reference of the available data during book's parsing and theme generation.
+
+### Global Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `book` | Book-wide information + configuration settings from `book.json`. See below for details. |
+| `gitbook` | GitBook specific information |
+| `page` | Current page specific information |
+| `file` | File associated with the current page specific information |
+| `readme` | Information about the Readme |
+| `glossary` | Information about the Glossary |
+| `summary` | Information about the table of contents |
+| `languages` | List of languages for multi-lingual books |
+| `output` | Information about the output generator |
+| `config` | Dump of the `book.json` |
+
+### Book Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `book.language` | Current language for a multilingual book |
+| `book.[value]` | All other values under `variables` in the `book.json` are accessible here |
+
+For example, with this `book.json`:
+
+```json
+{
+  variables: {
+    hello: "everyone"
+  }
+}
+```
+
+... the following text `{{ book.hello }}` will expand to `everyone`.
+
+### GitBook Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `gitbook.time` | The current time (when you run the `gitbook` command). |
+| `gitbook.version` | Version of GitBook used to generate the book |
+
+### File Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `file.path` | The path to the raw page |
+| `file.mtime` | Modified Time. Last time the file was modified |
+| `file.type` | The name of the parser used to compile this file (ex: `markdown`, `asciidoc`, etc) |
+
+#### Page Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `page.title` | Title of the page |
+| `page.previous` | Previous page in the Table of Contents (can be `null`) |
+| `page.next` | Next page in the Table of Contents (can be `null`) |
+| `page.dir` | Text direction, based on configuration or detected from content (`rtl` or `ltr`) |
+
+#### Table of Contents Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `summary.parts` | List of sections in the Table of Contents |
+
+The whole table of contents (`SUMMARY.md`) can be accessed:
+
+`summary.parts[0].articles[0].title` will return the title of the first article.
+
+#### Multi-lingual book Variable
+
+| Variable | Description |
+| -------- | ----------- |
+| `languages.list` | List of languages for this book |
+
+Languages are defined by `{ id: 'en', title: 'English' }`.
+
+### Output Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `output.name` | Name of the output generator, possible values are `website`, `json`, `ebook` |
+| `output.format` | When `output.name == "ebook"`, `format` defines the ebook format that will be generated, possible values are `pdf`, `epub` or `mobi` |
+
+### Readme Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `readme.path` | Path to the Readme in the book |
+
+### Glossary Variables
+
+| Variable | Description |
+| -------- | ----------- |
+| `glossary.path` | Path to the Glossary in the book |

docs/themes/README.md

@@ -0,0 +1,39 @@
+# Theming
+
+Since version 3.0.0, GitBook can be easily themed. Books use the [theme-default](https://github.com/GitbookIO/theme-default) theme by default.
+
+> **Caution**: Custom theming can block some plugins from working correctly.
+
+### Structure of a theme
+
+A theme is a plugin containing templates and assets. Overriding any individual template is optional, since themes always extend the default theme.
+
+| Folder | Description |
+| -------- | ----------- |
+| `_layouts` | Main folder containing all the templates |
+| `_layouts/website/page.html` | Template for a normal page |
+| `_layouts/ebook/page.html` | Template for a normal page during ebook generation (PDF, ePub, Mobi) |
+
+
+### Extend/Customize theme in a book
+
+Authors can extend the templates of a theme directly from their book's source (without creating an external theme). Templates will be resolved in the `_layouts` folder of the book first, then in the installed plugins/themes.
+
+### Extend instead of Forking
+
+When you want to make your theme changes available to multiple books, instead of forking the default theme, you can extend it using the [templating syntax](../templating/README.md):
+
+```html
+{% extends template.self %}
+
+{% block body %}
+    {{ super() }}
+    ... This will be added to the "body" block
+{% endblock %}
+```
+
+Take a look at the [API](https://github.com/GitbookIO/theme-api) theme for a more complete example.
+
+### Publish a theme
+
+Themes are published as plugins ([see related docs](../plugins/README.md)) with a `theme-` prefix. For example the theme `awesome` will be loaded from the `theme-awesome` plugin, and then from the `gitbook-plugin-theme-awesome` NPM package.

lerna.json

@@ -0,0 +1,4 @@
+{
+  "lerna": "2.0.0-beta.31",
+  "version": "4.0.0-alpha.2"
+}

lib/generate/config.js

@@ -1,105 +0,0 @@
-var _ = require('lodash');
-var path = require('path');
-
-// Default configuration for gitbook
-var CONFIG = {
-    // Folders to use for output
-    // Caution: it overrides the value from the command line
-    // It's not advised this option in the book.json
-    "output": null,
-
-    // Generator to use for building
-    // Caution: it overrides the value from the command line
-    // It's not advised this option in the book.json
-    "generator": "site",
-
-    // Configuration file to use
-    "configFile": "book",
-
-    // Book title and description (defaults are extracted from the README)
-    "title": null,
-    "description": null,
-
-    // For ebook format, the extension to use for generation (default is detected from output extension)
-    // "epub", "pdf", "mobi"
-    // Caution: it overrides the value from the command line
-    // It's not advised this option in the book.json
-    "extension": null,
-
-    // Plugins list, can contain "-name" for removing default plugins
-    "plugins": [],
-
-    // Global configuration for plugins
-    "pluginsConfig": {
-        "fontSettings": {
-            "theme": null, //"sepia", "night" or "white",
-            "family": "sans",// "serif" or "sans",
-            "size": 2 // 1 - 4
-        }
-    },
-
-    // Variables for templating
-    "variables": {},
-
-    // Set another theme with your own layout
-    // It's recommended to use plugins or add more options for default theme, though
-    // See https://github.com/GitbookIO/gitbook/issues/209
-    "theme": path.resolve(__dirname, '../../theme'),
-
-    // Links in template (null: default, false: remove, string: new value)
-    "links": {
-        // Custom links at top of sidebar
-        "sidebar": {
-            //"Custom link name": "https://customlink.com"
-        },
-
-        // Sharing links
-        "sharing": {
-            "google": null,
-            "facebook": null,
-            "twitter": null,
-            "weibo": null,
-            "all": null
-        }
-    },
-
-
-    // Options for PDF generation
-    "pdf": {
-        // Add toc at the end of the file
-        "toc": true,
-
-        // Add page numbers to the bottom of every page
-        "pageNumbers": false,
-
-        // Font size for the file content
-        "fontSize": 12,
-
-        // Paper size for the pdf
-        // Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’]
-        "paperSize": "a4",
-
-        // Margin (in pts)
-        // Note: 72 pts equals 1 inch
-        "margin": {
-            "right": 62,
-            "left": 62,
-            "top": 36,
-            "bottom": 36
-        },
-
-        //Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
-        "headerTemplate": "",
-
-        //Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
-        "footerTemplate": ""
-    }
-};
-
-module.exports = {
-    CONFIG: CONFIG,
-    defaults: function(options) {
-        return _.merge(options || {}, CONFIG, _.defaults);
-    }
-}
-

lib/generate/ebook/index.js

@@ -1,86 +0,0 @@
-var util = require("util");
-var path = require("path");
-var Q = require("q");
-var _ = require("lodash");
-var exec = require('child_process').exec;
-
-var fs = require('graceful-fs');
-var parse = require("../../parse");
-var BaseGenerator = require("../page");
-var stringUtils = require("../../utils/string");
-
-var Generator = function() {
-    BaseGenerator.apply(this, arguments);
-};
-util.inherits(Generator, BaseGenerator);
-
-Generator.prototype.finish = function() {
-    var that = this;
-
-    return BaseGenerator.prototype.finish.apply(this)
-    .then(function() {
-        var d = Q.defer();
-        var format = that.options.extension || path.extname(that.options.output).replace("\.", "") || "pdf";
-
-        if (!that.options.cover && fs.existsSync(path.join(that.options.output, "cover.jpg"))) {
-            that.options.cover = path.join(that.options.output, "cover.jpg");
-        }
-
-        var _options = {
-            "--cover": that.options.cover,
-            "--title": that.options.title,
-            "--comments": that.options.description,
-            "--authors": that.options.author,
-            "--publisher": "GitBook",
-            "--chapter": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter ')]",
-            "--chapter-mark": "pagebreak",
-            "--page-breaks-before": "/",
-            "--level1-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-1 ')]",
-            "--level2-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-2 ')]",
-            "--level3-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-3 ')]",
-            "--no-chapters-in-toc": true,
-            "--max-levels": "1",
-            "--breadth-first": true
-        };
-
-        if (format == "pdf") {
-            var pdfOptions = that.options.pdf;
-
-            _.extend(_options, {
-                "--margin-left": String(pdfOptions.margin.left),
-                "--margin-right": String(pdfOptions.margin.right),
-                "--margin-top": String(pdfOptions.margin.top),
-                "--margin-bottom": String(pdfOptions.margin.bottom),
-                "--pdf-default-font-size": String(pdfOptions.fontSize),
-                "--pdf-mono-font-size": String(pdfOptions.fontSize),
-                "--paper-size": String(pdfOptions.paperSize),
-                "--pdf-page-numbers": Boolean(pdfOptions.pageNumbers),
-                "--pdf-header-template": String(pdfOptions.headerTemplate),
-                "--pdf-footer-template": String(pdfOptions.footerTemplate)
-            });
-        }
-
-        var command = [
-            "ebook-convert",
-            path.join(that.options.output, "SUMMARY.html"),
-            path.join(that.options.output, "index."+format),
-            stringUtils.optionsToShellArgs(_options)
-        ].join(" ");
-
-        exec(command, function (error, stdout, stderr) {
-            if (error) {
-                if (error.code == 127) {
-                    error.message = "Need to install ebook-convert from Calibre";
-                } else {
-                    error.message = error.message + " "+stdout;
-                }
-                return d.reject(error);
-            }
-            d.resolve();
-        });
-
-        return d.promise;
-    });
-};
-
-module.exports = Generator;

lib/generate/fs.js

@@ -1,78 +0,0 @@
-var Q = require("q");
-var fs = require('graceful-fs');
-var fsExtra = require("fs-extra");
-var Ignore = require("fstream-ignore");
-
-var getFiles = function(path) {
-    var d = Q.defer();
-
-    // Our list of files
-    var files = [];
-
-    var ig = Ignore({
-        path: path,
-        ignoreFiles: ['.ignore', '.gitignore', '.bookignore']
-    });
-
-    // Add extra rules to ignore common folders
-    ig.addIgnoreRules([
-        // Skip Git stuff
-        '.git/',
-        '.gitignore',
-
-        // Skip OS X meta data
-        '.DS_Store',
-
-        // Skip stuff installed by plugins
-        'node_modules',
-
-        // Skip book outputs
-        '*.pdf',
-        '*.epub',
-        '*.mobi',
-
-        // Skip config files
-        '.ignore',
-        '.bookignore',
-        'book.json',
-    ], '__custom_stuff');
-
-    // Push each file to our list
-    ig.on('child', function (c) {
-        files.push(
-            c.path.substr(c.root.path.length + 1) + (c.props.Directory === true ? '/' : '')
-        );
-    });
-
-    ig.on('end', function() {
-        // Normalize paths on Windows
-        if(process.platform === 'win32') {
-            return d.resolve(files.map(function(file) {
-                return file.replace(/\\/g, '/');
-            }));
-        }
-
-        // Simply return paths otherwise
-        return d.resolve(files);
-    });
-
-    ig.on('error', d.reject);
-
-    return d.promise;
-};
-
-module.exports = {
-    list: getFiles,
-    readFile: Q.denodeify(fs.readFile),
-    writeFile: Q.denodeify(fs.writeFile),
-    mkdirp: Q.denodeify(fsExtra.mkdirp),
-    copy: Q.denodeify(fsExtra.copy),
-    remove: Q.denodeify(fsExtra.remove),
-    symlink: Q.denodeify(fsExtra.symlink),
-    exists: function(path) {
-        var d = Q.defer();
-        fs.exists(path, d.resolve);
-        return d.promise;
-    },
-    readFileSync: fs.readFileSync.bind(fs)
-};

lib/generate/generator.js

@@ -1,87 +0,0 @@
-var _ = require("lodash");
-var path = require("path");
-var Q = require("q");
-var fs = require("./fs");
-
-var Plugin = require("./plugin");
-
-var BaseGenerator = function(options) {
-    this.options = options;
-
-    // Base for assets in plugins
-    this.pluginAssetsBase = "book";
-
-    this.options.plugins = Plugin.normalizeNames(this.options.plugins);
-    this.options.plugins = _.union(this.options.plugins, this.options.defaultsPlugins);
-    this.plugins = [];
-};
-
-BaseGenerator.prototype.callHook = function(name, data) {
-    return this.plugins.hook(name, data);
-};
-
-// Sets up generator
-BaseGenerator.prototype.load = function() {
-    return this.loadPlugins();
-};
-
-BaseGenerator.prototype.loadPlugins = function() {
-    var that = this;
-
-    return Plugin.fromList(this.options.plugins, this.options.input, this, {
-        assetsBase: this.pluginAssetsBase
-    })
-    .then(function(_plugins) {
-        that.plugins = _plugins;
-
-        return that.callHook("init");
-    });
-};
-
-BaseGenerator.prototype.convertFile = function(content, input) {
-    return Q.reject(new Error("Could not convert "+input));
-};
-
-BaseGenerator.prototype.transferFile = function(input) {
-    return fs.copy(
-        path.join(this.options.input, input),
-        path.join(this.options.output, input)
-    );
-};
-
-BaseGenerator.prototype.transferFolder = function(input) {
-    return fs.mkdirp(
-        path.join(this.options.output, input)
-    );
-};
-
-BaseGenerator.prototype.copyCover = function() {
-    var that = this;
-
-    return Q.all([
-        fs.copy(path.join(this.options.input, "cover.jpg"), path.join(this.options.output, "cover.jpg")),
-        fs.copy(path.join(this.options.input, "cover_small.jpg"), path.join(this.options.output, "cover_small.jpg"))
-    ])
-    .fail(function() {
-        // If orignally from multi-lang, try copy from originalInput
-        if (!that.options.originalInput) return;
-
-        return Q.all([
-            fs.copy(path.join(that.options.originalInput, "cover.jpg"), path.join(that.options.output, "cover.jpg")),
-            fs.copy(path.join(that.options.originalInput, "cover_small.jpg"), path.join(that.options.output, "cover_small.jpg"))
-        ]);
-    })
-    .fail(function(err) {
-        return Q();
-    });
-};
-
-BaseGenerator.prototype.langsIndex = function(langs) {
-    return Q.reject(new Error("Langs index is not supported in this generator"));
-};
-
-BaseGenerator.prototype.finish = function() {
-    return Q.reject(new Error("Could not finish generation"));
-};
-
-module.exports = BaseGenerator;

lib/generate/index.js

@@ -1,378 +0,0 @@
-var Q = require("q");
-var _ = require("lodash");
-var path = require("path");
-var tmp = require('tmp');
-
-var swig = require('./template');
-var fs = require("./fs");
-var parse = require("../parse");
-var Plugin = require("./plugin");
-var defaultConfig = require("./config");
-
-var generators = {
-    "site": require("./site"),
-    "page": require("./page"),
-    "ebook": require("./ebook"),
-    "json": require("./json")
-};
-
-var defaultDescription = "Book generated using GitBook";
-
-
-var containsFiles = function(dir, files) {
-    return Q.all(_.map(files, function(file) {
-        return fs.exists(path.join(dir, file));
-    }))
-    .then(_.all);
-};
-
-// Test if generator exists
-var checkGenerator = function(options) {
-    if (!generators[options.generator]) {
-        return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")+")"));
-    }
-    return Q();
-};
-
-// Create the generator and load plugins
-var loadGenerator = function(options) {
-    return checkGenerator(options)
-    .then(function() {
-        var generator = new generators[options.generator](options);
-
-        return generator.load()
-        .then(_.constant(generator));
-    });
-};
-
-
-
-var generate = function(options) {
-    // Set defaults to options
-    options = defaultConfig.defaults(options);
-
-    // Validate options
-    if (!options.input) {
-        return Q.reject(new Error("Need option input (book input directory)"));
-    }
-
-    // Check files to get folder type (book, multilanguage book or neither)
-    return checkGenerator(options)
-
-    // Read config file
-    .then(function() {
-        try {
-            var _config = require(path.resolve(options.input, options.configFile));
-
-            options = _.merge(options, _.omit(_config, 'input', 'configFile', 'defaultsPlugins'));
-        }
-        catch(err) {
-            // No config file: not a big deal
-            return Q();
-        }
-    })
-
-    // Read readme
-    .then(function() {
-        return fs.readFile(path.join(options.input, "README.md"), "utf-8")
-        .then(function(_readme) {
-            _readme = parse.readme(_readme);
-
-            options.title = options.title || _readme.title;
-            options.description = options.description || _readme.description || defaultDescription;
-        });
-    })
-
-    // Detect multi-languages book
-    .then(function() {
-        return containsFiles(options.input, ['LANGS.md'])
-    })
-
-    .then(function(isMultiLang) {
-        // Multi language book
-        if(isMultiLang) {
-            return generateMultiLang(options);
-        }
-
-        // Book
-        return generateBook(options);
-    });
-};
-
-
-var generateMultiLang = function(options) {
-    var langsSummary;
-    options.output = options.output || path.join(options.input, "_book");
-
-    return checkGenerator(options)
-
-    // Multi-languages book
-    .then(function() {
-        return fs.readFile(path.join(options.input, "LANGS.md"), "utf-8")
-    })
-
-    // Clean output folder
-    .then(function(_langsSummary) {
-        langsSummary = _langsSummary;
-        return fs.remove(options.output);
-    })
-    .then(function() {
-        return fs.mkdirp(options.output);
-    })
-
-    // Generate sub-books
-    .then(function() {
-        options.langsSummary = parse.langs(langsSummary);
-
-        // Generated a book for each valid entry
-        return _.reduce(options.langsSummary.list, function(prev, entry) {
-            return prev.then(function() {
-                return generate(_.extend({}, options, {
-                    input: path.join(options.input, entry.path),
-                    output: path.join(options.output, entry.path),
-                    originalInput: options.input,
-                    originalOutput: options.output
-                }));
-            })
-        }, Q());
-    })
-
-    .then(function() {
-        return loadGenerator(options);
-    })
-
-    // Generate languages index
-    .then(function(generator) {
-        return generator.langsIndex(options.langsSummary);
-    })
-
-    // Copy cover file
-    .then(function() {
-        return Q.all([
-            fs.copy(path.join(options.input, "cover.jpg"), path.join(options.output, "cover.jpg")),
-            fs.copy(path.join(options.input, "cover_small.jpg"), path.join(options.output, "cover_small.jpg"))
-        ])
-        .fail(function() {
-            return Q();
-        })
-    })
-
-    // Return options to caller
-    .then(_.constant(options));
-};
-
-/*
- *  Use a specific generator to convert a gitbook to a site/pdf/ebook/
- *  output is always a folder
- */
-var generateBook = function(options) {
-    var files;
-
-    options.output = options.output || path.join(options.input, "_book");
-
-    // Check if it's a book
-    return containsFiles(options.input, ['SUMMARY.md', 'README.md'])
-
-    // Fail if not a book
-    .then(function(isBook) {
-        if(!isBook) {
-            return Q.reject(new Error("Invalid gitbook repository, need SUMMARY.md and README.md"));
-        }
-    })
-
-    // Clean output folder
-    .then(function() {
-        return fs.remove(options.output);
-    })
-
-    .then(function() {
-        return fs.mkdirp(options.output);
-    })
-
-    // List all files in the repository
-    .then(function() {
-        return fs.list(options.input)
-        .then(function(_files) {
-            files = _files;
-        });
-    })
-
-    .then(function() {
-        return loadGenerator(options);
-    })
-
-    // Convert files
-    .then(function(generator) {
-        // Generate the book
-        return Q()
-
-        // Get summary
-        .then(function() {
-            var summary = {
-                path: path.join(options.input, "SUMMARY.md")
-            };
-
-            var _callHook = function(name) {
-                return generator.callHook(name, summary)
-                .then(function(_summary) {
-                    summary = _summary;
-                    return summary;
-                });
-            };
-
-            return fs.readFile(summary.path, "utf-8")
-                .then(function(_content) {
-                    summary.content = _content;
-                    return _callHook("summary:before");
-                })
-                .then(function() {
-                    summary.content = parse.summary(summary.content);
-                    return _callHook("summary:after");
-                })
-                .then(function() {
-                    options.summary = summary.content;
-                    options.navigation = parse.navigation(options.summary);
-                });
-        })
-
-        // Read glossary
-        .then(function() {
-            var glossary = {};
-
-            var _callHook = function(name) {
-                return generator.callHook(name, glossary)
-                .then(function(_glossary) {
-                    glossary = _glossary;
-                    return glossary;
-                });
-            };
-
-            return fs.readFile(path.join(options.input, "GLOSSARY.md"), "utf-8")
-                .fail(function() {
-                    return "";
-                })
-                .then(function(_content) {
-                    glossary.content = _content;
-                    return _callHook("glossary:before");
-                })
-                .then(function() {
-                    glossary.content = parse.glossary(glossary.content);
-                    return _callHook("glossary:after");
-                })
-                .then(function() {
-                    options.glossary = glossary.content;
-                });
-        })
-
-        // Skip processing some files
-        .then(function() {
-            files = _.filter(files, function (file) {
-                return !(
-                    file === 'SUMMARY.md' ||
-                    file === 'GLOSSARY.md'
-                );
-            });
-        })
-
-        // Copy file and replace markdown file
-        .then(function() {
-            return Q.all(
-                _.chain(files)
-                .map(function(file) {
-                    if (!file) return;
-
-                    if (file[file.length -1] == "/") {
-                        return Q(generator.transferFolder(file));
-                    } else if (path.extname(file) == ".md" && options.navigation[file] != null) {
-                        return fs.readFile(path.join(options.input, file), "utf-8")
-                        .then(function(content) {
-                            return Q(generator.convertFile(content, file));
-                        });
-                    } else {
-                        return Q(generator.transferFile(file));
-                    }
-                })
-                .value()
-            );
-        })
-
-        // Finish generation
-        .then(function() {
-            return generator.finish();
-        })
-        .then(function() {
-            return generator.callHook("finish");
-        });
-    })
-
-    // Return all options
-    .then(function() {
-        return options;
-    });
-};
-
-/*
- *  Extract files from generate output in a temporary folder
- */
-var generateFile = function(options) {
-    options = _.defaults(options || {}, {
-        input: null,
-        output: null,
-        extension: null
-    });
-
-    return Q.nfcall(tmp.dir)
-    .then(function(tmpDir) {
-        return generate(
-            _.extend({},
-                options,
-                {
-                    output: tmpDir
-                })
-        )
-        .then(function(_options) {
-            var ext = options.extension;
-            var outputFile = options.output || path.resolve(options.input, "book."+ext);
-
-            var copyFile = function(lang) {
-                var _outputFile = outputFile;
-                var _tmpDir = tmpDir;
-
-                if (lang) {
-                    _outputFile = _outputFile.slice(0, -path.extname(_outputFile).length)+"_"+lang+path.extname(_outputFile);
-                    _tmpDir = path.join(_tmpDir, lang);
-                }
-
-                return fs.copy(
-                    path.join(_tmpDir, "index."+ext),
-                    _outputFile
-                );
-            };
-
-            // Multi-langs book
-            return Q()
-            .then(function() {
-                if (_options.langsSummary) {
-                    return Q.all(
-                        _.map(_options.langsSummary.list, function(lang) {
-                            return copyFile(lang.lang);
-                        })
-                    );
-                } else {
-                    return copyFile();
-                }
-            })
-            .then(function() {
-                return fs.remove(tmpDir);
-            });
-        });
-    });
-};
-
-module.exports = {
-    generators: generators,
-    folder: generate,
-    file: generateFile,
-    book: generateBook,
-    Plugin: Plugin,
-};

lib/generate/init.js

@@ -1,69 +0,0 @@
-var Q = require('q');
-var _ = require('lodash');
-
-var path = require('path');
-
-var fs = require('./fs');
-var parse = require('../parse');
-
-
-// Extract paths out of a summary
-function paths(summary) {
-    return _.reduce(summary.chapters, function(accu, chapter) {
-        return accu.concat(
-            _.filter([chapter.path].concat(_.pluck(chapter.articles, 'path')))
-        );
-    }, []);
-}
-
-// Get the parent folders out of a group of files
-function folders(files) {
-    return _.chain(files)
-    .map(function(file) {
-        return path.dirname(file);
-    })
-    .uniq()
-    .value();
-}
-
-function initDir(dir) {
-    return fs.readFile(path.join(dir, 'SUMMARY.md'), 'utf8')
-    .then(function(src) {
-        // Parse summary
-        return parse.summary(src);
-    })
-    .then(function(summary) {
-        // Extract paths from summary
-        return paths(summary);
-    })
-    .then(function(paths) {
-        // Convert to absolute paths
-        return _.map(paths, function(file) {
-            return path.resolve(file);
-        });
-    })
-    .then(function(files) {
-        // Create folders
-        return Q.all(_.map(folders(files), function(folder) {
-            return fs.mkdirp(folder);
-        }))
-        .then(_.constant(files));
-    })
-    .then(function(files) {
-        // Create files that don't exist
-        return Q.all(_.map(files, function(file) {
-            return fs.exists(file)
-            .then(function(exists) {
-                if(exists) return;
-                return fs.writeFile(file, '');
-            });
-        }));
-    })
-    .fail(function(err) {
-        console.error(err.stack);
-    });
-}
-
-
-// Exports
-module.exports = initDir;

lib/generate/json/index.js

@@ -1,77 +0,0 @@
-var util = require("util");
-var path = require("path");
-var Q = require("q");
-var _ = require("lodash");
-
-var fs = require("../fs");
-var parse = require("../../parse");
-var BaseGenerator = require("../generator");
-
-
-var Generator = function() {
-    BaseGenerator.apply(this, arguments);
-};
-util.inherits(Generator, BaseGenerator);
-
-Generator.prototype.transferFile = function(input) {
-    // ignore
-};
-
-Generator.prototype.convertFile = function(content, input) {
-    var that = this;
-    var json = {
-        progress: parse.progress(this.options.navigation, input)
-    };
-
-    return Q()
-    .then(function() {
-        return parse.page(content, {
-            dir: path.dirname(input) || '/'
-        });
-    })
-    .then(function(parsed) {
-        json.lexed = parsed.lexed;
-        json.sections = parsed.sections;
-    })
-    .then(function() {
-        return fs.writeFile(
-            path.join(that.options.output, input.replace(".md", ".json")),
-            JSON.stringify(json, null, 4)
-        );
-    });
-};
-
-// Generate languages index
-// Contains the first languages readme and langs infos
-Generator.prototype.langsIndex = function(langs) {
-    var that = this;
-
-    if (langs.list.length == 0) return Q.reject("Need at least one language");
-
-    var mainLang = _.first(langs.list).lang;
-    console.log("Main language is", mainLang);
-
-    return Q()
-    .then(function() {
-        return fs.readFile(
-            path.join(that.options.output, mainLang, "README.json")
-        );
-    })
-    .then(function(content) {
-        var json = JSON.parse(content);
-        _.extend(json, {
-            langs: langs.list
-        });
-
-        return fs.writeFile(
-            path.join(that.options.output, "README.json"),
-            JSON.stringify(json, null, 4)
-        );
-    });
-};
-
-Generator.prototype.finish = function() {
-    // ignore
-};
-
-module.exports = Generator;

lib/generate/page/index.js

@@ -1,73 +0,0 @@
-var _ = require("lodash");
-var util = require("util");
-var path = require("path");
-var Q = require("q");
-var swig = require("../template");
-
-var fs = require("../fs");
-var parse = require("../../parse");
-var BaseGenerator = require("../site");
-
-var Generator = function() {
-    BaseGenerator.apply(this, arguments);
-
-    // Base for assets in plugins
-    this.pluginAssetsBase = "ebook";
-
-    // List of pages content
-    this.pages = {};
-};
-util.inherits(Generator, BaseGenerator);
-
-Generator.prototype.loadTemplates = function() {
-    this.template = swig.compileFile(
-        this.plugins.template("ebook:page") || path.resolve(this.options.theme, 'templates/ebook/page.html')
-    );
-    this.summaryTemplate = swig.compileFile(
-        this.plugins.template("ebook:sumary") || path.resolve(this.options.theme, 'templates/ebook/summary.html')
-    );
-};
-
-// Generate table of contents
-Generator.prototype.writeToc = function() {
-    var that = this;
-    var basePath = ".";
-
-    return this._writeTemplate(this.summaryTemplate, {
-        toc: parse.progress(this.options.navigation, "README.md").chapters,
-        basePath: basePath,
-        staticBase: path.join(basePath, "gitbook"),
-    }, path.join(this.options.output, "SUMMARY.html"));
-};
-
-Generator.prototype.finish = function() {
-    var that = this;
-    var basePath = ".";
-    var output = path.join(this.options.output, "index.html");
-
-    var progress = parse.progress(this.options.navigation, "README.md");
-
-    return Q()
-
-    // Write table of contents
-    .then(function() {
-        return that.writeToc();
-    })
-
-    // Copy cover
-    .then(function() {
-        return that.copyCover();
-    })
-
-    // Copy assets
-    .then(function() {
-        return that.copyAssets();
-    });
-};
-
-// Generate languages index
-Generator.prototype.langsIndex = function(langs) {
-    return Q();
-};
-
-module.exports = Generator;

lib/generate/plugin.js

@@ -1,284 +0,0 @@
-var _ = require("lodash");
-var Q = require("q");
-var semver = require("semver");
-var path = require("path");
-var url = require("url");
-var fs = require("./fs");
-var resolve = require('resolve');
-
-var pkg = require("../../package.json");
-
-var RESOURCES = ["js", "css"];
-
-var Plugin = function(name, root, generator) {
-    this.name = name;
-    this.root = root;
-    this.packageInfos = {};
-    this.infos = {};
-    this.generator = generator;
-
-    // Bind methods
-    _.bindAll(this);
-
-    _.each([
-        "gitbook-plugin-"+name,
-        "gitbook-theme-"+name,
-        "gitbook-"+name,
-        name,
-    ], function(_name) {
-        if (this.load(_name, __dirname)) return false;
-        if (this.load(_name, path.resolve(root))) return false;
-    }, this);
-};
-
-// Load from a name
-Plugin.prototype.load = function(name, baseDir) {
-    try {
-        var res = resolve.sync(name+"/package.json", { basedir: baseDir });
-
-        this.baseDir = path.dirname(res);
-        this.packageInfos = require(res);
-        this.infos = require(resolve.sync(name, { basedir: baseDir }));
-        this.name = name;
-
-        return true;
-    } catch (e) {
-        return false;
-    }
-};
-
-Plugin.prototype.normalizeResource = function(resource) {
-    // Parse the resource path
-    var parsed = url.parse(resource);
-
-    // This is a remote resource
-    // so we will simply link to using it's URL
-    if (parsed.protocol) {
-        return {
-            "url": resource
-        };
-    }
-
-    // This will be copied over from disk
-    // and shipped with the book's build
-    return { "path": this.name+"/"+resource };
-};
-
-// Return resources
-Plugin.prototype._getResources = function(base) {
-    base = base || "book";
-    var book = this.infos[base];
-
-    // Nothing specified, fallback to default
-    if (!book) {
-        return Q({});
-    }
-
-    // Dynamic function
-    if(typeof book === "function") {
-        // Call giving it the context of our generator
-        return Q().then(book.bind(this.generator));
-    }
-
-    // Plain data object
-    return Q(_.cloneDeep(book));
-};
-
-// Normalize resources and return them
-Plugin.prototype.getResources = function(base) {
-    var that = this;
-
-    return this._getResources(base)
-    .then(function(resources) {
-
-        _.each(RESOURCES, function(resourceType) {
-            resources[resourceType] = (resources[resourceType] || []).map(that.normalizeResource);
-        });
-
-        return resources;
-    });
-};
-
-// Test if it's a valid plugin
-Plugin.prototype.isValid = function() {
-    return (
-        this.packageInfos &&
-        this.packageInfos.name &&
-        this.packageInfos.engines &&
-        this.packageInfos.engines.gitbook &&
-        semver.satisfies(pkg.version, this.packageInfos.engines.gitbook)
-    );
-};
-
-// Resolve file path
-Plugin.prototype.resolveFile = function(filename) {
-    return path.resolve(this.baseDir, filename);
-};
-
-// Resolve file path
-Plugin.prototype.callHook = function(name, data) {
-    // Our generator will be the context to apply
-    var context = this.generator;
-
-    var hookFunc = this.infos.hooks? this.infos.hooks[name] : null;
-    data = data || {};
-
-    if (!hookFunc) return Q(data);
-
-    return Q()
-    .then(function() {
-        return hookFunc.apply(context, [data]);
-    });
-};
-
-// Copy plugin assets fodler
-Plugin.prototype.copyAssets = function(out, options) {
-    var that = this;
-    options = _.defaults(options || {}, {
-        base: "book"
-    });
-
-    return this.getResources(options.base)
-    .get('assets')
-    .then(function(assets) {
-        // Assets are undefined
-        if(!assets) return false;
-
-        return fs.copy(
-            that.resolveFile(assets),
-            out
-        ).then(_.constant(true));
-    }, _.constant(false));
-};
-
-
-// Normalize a list of plugin name to use
-Plugin.normalizeNames = function(names) {
-    // Normalize list to an array
-    names = _.isString(names) ? names.split(",") : (names || []);
-
-    // List plugins to remove
-    var toremove = _.chain(names)
-    .filter(function(name) {
-        return name.length > 0 && name[0] == "-";
-    })
-    .map(function(name) {
-        return name.slice(1);
-    })
-    .value();
-
-    // Merge with defaults
-    names = _.chain(names)
-    .concat(Plugin.defaults)
-    .uniq()
-    .value();
-
-    // Remove plugins starting with
-    names = _.filter(names, function(name) {
-        return !_.contains(toremove, name) && !(name.length > 0 && name[0] == "-");
-    });
-
-    return names;
-};
-
-// Extract data from a list of plugin
-Plugin.fromList = function(names, root, generator, options) {
-    options = _.defaults(options || {}, {
-        assetsBase: "book"
-    });
-
-    var failed = [];
-
-    // Load plugins
-    var plugins = _.map(names, function(name) {
-        var plugin = new Plugin(name, root, generator);
-        if (!plugin.isValid()) failed.push(name);
-        return plugin;
-    });
-
-    if (_.size(failed) > 0) return Q.reject(new Error("Error loading plugins: "+failed.join(",")));
-
-    // The raw resources extracted from each plugin
-    var pluginResources;
-
-    // Get resources of plugins
-    return Q.all(_.map(plugins, function(plugin) {
-        return plugin.getResources(options.assetsBase);
-    }))
-    // Extract resources out
-    // css, js, etc ...
-    .then(function(resources) {
-        pluginResources = resources;
-        // Group by resource types
-        return _.chain(RESOURCES)
-        .map(function(resourceType) {
-            // Get resources from all the plugins for this current type
-            return [
-                // Key
-                resourceType,
-                // Value
-                _.chain(resources)
-                .pluck(resourceType)
-                .compact()
-                .flatten()
-                .value()
-            ];
-        })
-        .object()
-        .value();
-    })
-    // Extract html snippets
-    .then(function(resources) {
-        // Map of html resources by name added by each plugin
-        resources.html = pluginResources.reduce(function(accu, resource) {
-            var html = (resource && resource.html) || {};
-            _.each(html, function(code, key) {
-                // Turn into function if not one already
-                if (!_.isFunction(code)) code = _.constant(code);
-                // Append
-                accu[key] = (accu[key] || []).concat([code]);
-            });
-
-            return accu;
-        }, {});
-
-        return resources;
-    })
-    // Return big multi-plugin object
-    .then(function(resources) {
-        return {
-            'list': plugins,
-            'resources': resources,
-            'hook': function(name, data) {
-                return _.reduce(plugins, function(prev, plugin) {
-                    return prev.then(function(ret) {
-                        return plugin.callHook(name, ret);
-                    });
-                }, Q(data));
-            },
-            'template': function(name) {
-                var withTpl = _.find(plugins, function(plugin) {
-                    return (
-                        plugin.infos.templates &&
-                        plugin.infos.templates[name]
-                    );
-                });
-
-                if (!withTpl) return null;
-                return withTpl.resolveFile(withTpl.infos.templates[name]);
-            },
-            'html': function(tag, context, options) {
-                return _.map(resources.html[tag] || [], function(code) {
-                    return code.call(context, options);
-                }).join("\n");
-            }
-        };
-    });
-};
-
-// Default plugins
-Plugin.defaults = [
-    "mathjax"
-];
-
-module.exports = Plugin;

lib/generate/site/glossary_indexer.js

@@ -1,101 +0,0 @@
-var _ = require("lodash");
-var kramed = require('kramed');
-var textRenderer = require('kramed-text-renderer');
-
-var entryId = require('../../parse/glossary').entryId;
-
-
-function Indexer(glossary) {
-    if(!(this instanceof Indexer)) {
-        return new Indexer(glossary);
-    }
-
-    _.bindAll(this);
-
-    this.glossary = glossary || [];
-
-    this.glossaryTerms = _.pluck(this.glossary, "id");
-
-    // Regex for searching for terms through body
-    this.termsRegex = new RegExp(
-        // Match any of the terms
-        "("+
-            this.glossaryTerms.map(regexEscape).join('|') +
-        ")",
-
-        // Flags
-        "gi"
-    );
-
-    // page url => terms
-    this.idx = {
-        /*
-        "a/b.html": ["one word", "second word"]
-        */
-    };
-
-    // term => page urls
-    this.invertedIdx = {
-        /*
-        "word1": ["page1.html", "page2.html"]
-        */
-    };
-
-    // Use text renderer
-    this.renderer = textRenderer();
-}
-
-Indexer.prototype.text = function(nodes) {
-    // Copy section
-    var section = _.toArray(nodes);
-
-    // kramed's Render expects this, we don't use it yet
-    section.links = {};
-
-    var options = _.extend({}, kramed.defaults, {
-        renderer: this.renderer
-    });
-
-    return kramed.parser(section, options);
-};
-
-// Add page to glossary index
-Indexer.prototype.add = function(sections, url) {
-    if(!(this.glossary && this.glossary.length > 0)) {
-        return;
-    }
-
-    var textblob =
-    _.where(sections, { type: 'normal' })
-    .map(this.text)
-    .join('\n');
-
-    var matches = _(textblob.match(this.termsRegex) || [])
-    .map(entryId)
-    .uniq()
-    .value();
-
-    // Add idx for book
-    this.idx[url] = matches;
-
-    // Add to inverted idx
-    matches.forEach(function(match) {
-        if(!this.invertedIdx[match]) {
-            this.invertedIdx[match] = [];
-        }
-        this.invertedIdx[match].push(url);
-    }.bind(this));
-};
-
-// Dump index as a string
-Indexer.prototype.dump = function() {
-    return JSON.stringify(this.idx);
-};
-
-
-function regexEscape(s) {
-    return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
-}
-
-// Exports
-module.exports = Indexer;

lib/generate/site/index.js

@@ -1,293 +0,0 @@
-var util = require("util");
-var path = require("path");
-var Q = require("q");
-var _ = require("lodash");
-var swig = require("../template");
-
-var fs = require("../fs");
-var parse = require("../../parse");
-var BaseGenerator = require("../generator");
-var links = require("../../utils/links");
-var indexer = require('./search_indexer');
-var glossaryIndexer = require('./glossary_indexer');
-
-
-var Generator = function() {
-    BaseGenerator.apply(this, arguments);
-
-    // Attach methods to instance
-    _.bindAll(this);
-
-    this.revision = Date.now();
-    this.indexer = indexer();
-};
-util.inherits(Generator, BaseGenerator);
-
-// Add template loading to load
-Generator.prototype.load = function() {
-    var that = this;
-
-    return BaseGenerator.prototype.load.apply(this)
-    .then(function() {
-        return that.loadTemplates();
-    });
-};
-
-// Load all templates
-Generator.prototype.loadTemplates = function() {
-    this.template = swig.compileFile(
-        this.plugins.template("site:page") || path.resolve(this.options.theme, 'templates/book/page.html')
-    );
-    this.langsTemplate = swig.compileFile(
-        this.plugins.template("site:langs") || path.resolve(this.options.theme, 'templates/book/langs.html')
-    );
-    this.glossaryTemplate = swig.compileFile(
-        this.plugins.template("site:glossary") || path.resolve(this.options.theme, 'templates/book/glossary.html')
-    );
-};
-
-// Generate a template
-Generator.prototype._writeTemplate = function(tpl, options, output, interpolate) {
-    var that = this;
-
-    interpolate = interpolate || _.identity;
-    return Q()
-    .then(function(sections) {
-        return tpl(_.extend({
-            revision: that.revision,
-
-            title: that.options.title,
-            description: that.options.description,
-
-            glossary: that.options.glossary,
-
-            summary: that.options.summary,
-            allNavigation: that.options.navigation,
-
-            plugins: that.plugins,
-            pluginsConfig: JSON.stringify(that.options.pluginsConfig),
-            htmlSnippet: _.partialRight(that.plugins.html, that, options),
-
-            options: that.options
-        }, options));
-    })
-    .then(interpolate)
-    .then(function(html) {
-        return fs.writeFile(
-            output,
-            html
-        );
-    });
-};
-
-Generator.prototype.indexPage = function(lexed, pagePath) {
-    // Setup glossary indexer if not yet setup
-    if(!this.glossaryIndexer) {
-        this.glossaryIndexer = glossaryIndexer(this.options.glossary);
-    }
-
-    this.indexer.add(lexed, pagePath);
-    this.glossaryIndexer.add(lexed, pagePath);
-    return Q();
-};
-
-// Convert a markdown file into a normalized data set
-Generator.prototype.prepareFile  = function(content, _input) {
-    var that = this;
-
-    var input = path.join(this.options.input, _input);
-
-    var page = {
-        path: _input,
-        rawPath: input,
-        content: content,
-        progress: parse.progress(this.options.navigation, _input)
-    };
-
-    var _callHook = function(name) {
-        return that.callHook(name, page)
-        .then(function(_page) {
-            page = _page;
-            return page;
-        });
-    };
-
-    return Q()
-    .then(function() {
-        // Send content to plugins
-        return _callHook("page:before");
-    })
-    .then(function() {
-        // Lex, parse includes and get
-        // Get HTML generated sections
-        return parse.page(page.content, {
-            // Local files path
-            dir: path.dirname(_input) || '/',
-
-            // Output directory
-            outdir: path.dirname(_input) || '/',
-
-            // Includer for templating
-            includer: parse.includer(that.options.variables, [
-                    path.dirname(_input) || '/',
-                    path.join(that.options.input, '_includes'),
-            ], path.join, fs.readFileSync)
-        });
-    })
-    .then(function(parsed) {
-        page.lexed = parsed.lexed;
-        page.sections = parsed.sections;
-
-        // Use plugin hook
-        return _callHook("page");
-    })
-    .then(function() {
-        return page;
-    });
-};
-
-// Convert a markdown file to html
-Generator.prototype.convertFile = function(content, _input) {
-    var that = this;
-
-    var _output = _input.replace(".md", ".html");
-    if (_output == "README.html") _output = "index.html";
-    var output = path.join(this.options.output, _output);
-    var basePath = path.relative(path.dirname(output), this.options.output) || ".";
-	
-	// Bug fix for issue #493 which would occur when relative-links are 2-level or more deep in win32
-	if (process.platform === 'win32') {
-		basePath = basePath.replace(/\\/g, '/');
-	}
-	
-    return this.prepareFile(content, _input)
-    .then(function(page) {
-        // Index page in search
-        return that.indexPage(page.lexed, _output).thenResolve(page);
-    })
-    .then(function(page) {
-        // Write file
-        return that._writeTemplate(that.template, {
-            progress: page.progress,
-
-            _input: page.path,
-            content: page.sections,
-
-            basePath: basePath,
-            staticBase: links.join(basePath, "gitbook"),
-        }, output, function(html) {
-            page.content = html;
-
-            return that.callHook("page:after", page).get("content")
-        });
-    });
-};
-
-// Generate languages index
-Generator.prototype.langsIndex = function(langs) {
-    var that = this;
-    var basePath = ".";
-
-    return this._writeTemplate(this.langsTemplate, {
-        langs: langs.list,
-
-        basePath: basePath,
-        staticBase: path.join(basePath, "gitbook"),
-    }, path.join(this.options.output, "index.html"))
-    .then(function() {
-        // Copy assets
-        return that.copyAssets();
-    });
-};
-
-// Generate glossary
-Generator.prototype.writeGlossary = function() {
-    var that = this;
-    var basePath = ".";
-
-    // No glossary
-    if (!this.glossaryIndexer) return Q();
-
-    // Transform the glossary to get term, description, files
-    var glossary = _.chain(this.glossaryIndexer.invertedIdx)
-    .map(function(links, id) {
-        var term = _.find(that.options.glossary, { 'id': id });
-
-        return {
-            id: id,
-            name: term.name,
-            description: term.description,
-            files: _.chain(links)
-                .map(function(link) {
-                    var name = link.slice(0, -5);
-
-                    if (name == "index") {
-                        name = "README";
-                    }
-                    return that.options.navigation[name+".md"];
-                })
-                .sortBy("percent")
-                .value()
-        }
-    })
-    .sortBy("name")
-    .value();
-
-    return this._writeTemplate(this.glossaryTemplate, {
-        glossaryIndex: glossary,
-        basePath: basePath,
-        staticBase: path.join(basePath, "gitbook"),
-    }, path.join(this.options.output, "GLOSSARY.html"));
-};
-
-// Copy assets
-Generator.prototype.copyAssets = function() {
-    var that = this;
-
-    // Copy gitbook assets
-    return fs.copy(
-        path.join(that.options.theme, "assets"),
-        path.join(that.options.output, "gitbook")
-    )
-
-    // Copy plugins assets
-    .then(function() {
-        return Q.all(
-            _.map(that.plugins.list, function(plugin) {
-                var pluginAssets = path.join(that.options.output, "gitbook/plugins/", plugin.name);
-                return plugin.copyAssets(pluginAssets, {
-                    base: that.pluginAssetsBase
-                });
-            })
-        );
-    });
-};
-
-// Dump search index to disk
-Generator.prototype.writeSearchIndex = function() {
-    return fs.writeFile(
-        path.join(this.options.output, 'search_index.json'),
-        this.indexer.dump()
-    );
-};
-
-// Dump glossary index to disk
-Generator.prototype.writeGlossaryIndex = function() {
-    if (!this.glossaryIndexer) return Q();
-
-    return fs.writeFile(
-        path.join(this.options.output, 'glossary_index.json'),
-        JSON.stringify(this.options.glossary)
-    );
-};
-
-
-Generator.prototype.finish = function() {
-    return this.copyAssets()
-    .then(this.copyCover)
-    .then(this.writeGlossary)
-    .then(this.writeGlossaryIndex)
-    .then(this.writeSearchIndex);
-};
-
-module.exports = Generator;

lib/generate/site/search_indexer.js

@@ -1,71 +0,0 @@
-var Q = require("q");
-var _ = require("lodash");
-
-var lunr = require('lunr');
-var kramed = require('kramed');
-var textRenderer = require('kramed-text-renderer');
-
-
-function Indexer() {
-    if(!(this instanceof Indexer)) {
-        return new Indexer();
-    }
-
-    _.bindAll(this);
-
-    // Setup lunr index
-    this.idx = lunr(function () {
-        this.ref('url');
-
-        this.field('title', { boost: 10 });
-        this.field('body');
-    });
-
-    this.renderer = textRenderer();
-}
-
-Indexer.prototype.text = function(nodes) {
-    // Copy section
-    var section = _.toArray(nodes);
-
-    // kramed's Render expects this, we don't use it yet
-    section.links = {};
-
-    var options = _.extend({}, kramed.defaults, {
-        renderer: this.renderer
-    });
-
-    return kramed.parser(section, options);
-};
-
-Indexer.prototype.addSection = function(path, section) {
-    var url = [path, section.id].join('#');
-
-    var title = this.text(
-        _.filter(section, {'type': 'heading'})
-    );
-
-    var body = this.text(
-        _.omit(section, {'type': 'heading'})
-    );
-
-    // Add to lunr index
-    this.idx.add({
-        url: url,
-        title: title,
-        body: body,
-    });
-};
-
-Indexer.prototype.add = function(lexedPage, url) {
-    var sections = lexedPage;
-
-    _.map(sections, _.partial(this.addSection, url));
-};
-
-Indexer.prototype.dump = function() {
-    return JSON.stringify(this.idx);
-};
-
-// Exports
-module.exports = Indexer;

lib/generate/template.js

@@ -1,52 +0,0 @@
-var path = require("path");
-var swig = require('swig');
-var hljs = require('highlight.js');
-
-var links = require('../utils/').links;
-var pkg = require('../../package.json');
-
-swig.setDefaults({
-    locals: {
-        gitbook: {
-            version: pkg.version
-        }
-    }
-});
-
-// Swig filter for returning the count of lines in a code section
-swig.setFilter('lines', function(content) {
-    return content.split('\n').length;
-});
-
-// Swig filter for returning a link to the associated html file of a markdown file
-swig.setFilter('mdLink', function(link) {
-    var link = link.replace(".md", ".html");
-    if (link == "README.html") link = "index.html";
-    return link;
-});
-
-// Swig filter: highlight coloration
-swig.setFilter('code', function(code, lang) {
-    try {
-        return hljs.highlight(lang, code).value;
-    } catch(e) {
-        return hljs.highlightAuto(code).value;
-    }
-});
-
-// Convert a level into a deep level
-swig.setFilter('lvl', function(lvl) {
-    return lvl.split(".").length;
-});
-
-// Join path
-swig.setFilter('pathJoin', function(base, _path) {
-    return links.join(base, _path);
-});
-
-// Is a link an absolute link
-swig.setFilter('isExternalLink', function(link) {
-    return links.isExternal(link);
-});
-
-module.exports = swig;

lib/index.js

@@ -1,5 +0,0 @@
-module.exports = {
-    parse: require('./parse/'),
-    generate: require('./generate/')
-};
-

lib/parse/glossary.js

@@ -1,48 +0,0 @@
-var _ = require('lodash');
-var kramed = require('kramed');
-
-// Get all the pairs of header + paragraph in a list of nodes
-function groups(nodes) {
-    // A list of next nodes
-    var next = nodes.slice(1).concat(null);
-
-    return _.reduce(nodes, function(accu, node, idx) {
-        // Skip
-        if(!(
-            node.type === 'heading' &&
-            (next[idx] && next[idx].type === 'paragraph')
-        )) {
-            return accu;
-        }
-
-        // Add group
-        accu.push([
-            node,
-            next[idx]
-        ]);
-
-        return accu;
-    }, []);
-}
-
-function parseGlossary(src) {
-    var nodes = kramed.lexer(src);
-
-    return groups(nodes)
-    .map(function(pair) {
-        // Simplify each group to a simple object with name/description
-        return {
-            name: pair[0].text,
-            id: entryId(pair[0].text),
-            description: pair[1].text,
-        };
-    });
-}
-
-// Normalizes a glossary entry's name to create an ID
-function entryId(name) {
-    return name.toLowerCase();
-}
-
-module.exports = parseGlossary;
-module.exports.entryId = entryId;

lib/parse/include.js

@@ -1,12 +0,0 @@
-var _ = require('lodash');
-
-module.exports = function(markdown, includer) {
-    // Memoized include function (to cache lookups)
-    var _include = _.memoize(includer);
-
-    return markdown.replace(/{{([\s\S]+?)}}/g, function(match, key) {
-        // If fails leave content as is
-        key = key.trim();
-        return _include(key) || match;
-    });
-};

lib/parse/includer.js

@@ -1,15 +0,0 @@
-// Return a fs inclduer
-module.exports = function(ctx, folders, resolveFile, readFile) {
-    return function(name) {
-        return ctx[name] ||
-        folders.map(function(folder) {
-            // Try including snippet from FS
-            try {
-                var fname = resolveFile(folder, name);
-                // Trim trailing newlines/space of imported snippets
-                return readFile(fname, 'utf8').trimRight();
-            } catch(err) {}
-        })
-        .filter(Boolean)[0];
-    }
-};

lib/parse/index.js

@@ -1,11 +0,0 @@
-module.exports = {
-    summary: require('./summary'),
-    glossary: require('./glossary'),
-    langs: require('./langs'),
-    page: require('./page'),
-    lex: require('./lex'),
-    progress: require('./progress'),
-    navigation: require('./navigation'),
-    readme: require('./readme'),
-    includer: require('./includer')
-};

lib/parse/is_exercise.js

@@ -1,17 +0,0 @@
-var _ = require('lodash');
-
-function isExercise(nodes) {
-    var codeType = { type: 'code' };
-
-    // Number of code nodes in section
-    var len = _.filter(nodes, codeType).length;
-
-    return (
-        // Got 3 or 4 code blocks
-        (len === 3 || len === 4) &&
-        // Ensure all nodes are at the end
-        _.all(_.last(nodes, len), codeType)
-    );
-}
-
-module.exports = isExercise;

lib/parse/is_quiz.js

@@ -1,87 +0,0 @@
-var _ = require('lodash');
-
-function isQuizNode(node) {
-    return (/^[(\[][ x][)\]]/).test(node.text || node);
-}
-
-function isTableQuestion(nodes) {
-    var block = questionBlock(nodes);
-    return (
-        block.length === 1 &&
-        block[0].type === 'table' &&
-        _.all(block[0].cells[0].slice(1), isQuizNode)
-    );
-}
-
-function isListQuestion(nodes) {
-    var block = questionBlock(nodes);
-    // Counter of when we go in and out of lists
-    var inlist = 0;
-    // Number of lists we found
-    var lists = 0;
-    // Elements found outside a list
-    var outsiders = 0;
-    // Ensure that we have nothing except lists
-    _.each(block, function(node) {
-        if(node.type === 'list_start') {
-            inlist++;
-        } else if(node.type === 'list_end') {
-            inlist--;
-            lists++;
-        } else if(inlist === 0) {
-            // Found non list_start or list_end whilst outside a list
-            outsiders++;
-        }
-    });
-    return lists > 0 && outsiders === 0;
-}
-
-function isQuestion(nodes) {
-    return isListQuestion(nodes) || isTableQuestion(nodes);
-}
-
-// Remove (optional) paragraph header node and blockquote
-function questionBlock(nodes) {
-    return nodes.slice(
-        nodes[0].type === 'paragraph' ? 1 : 0,
-        _.findIndex(nodes, { type: 'blockquote_start' })
-    );
-}
-
-function splitQuestions(nodes) {
-    // Represents nodes in current question
-    var buffer = [];
-    return _.reduce(nodes, function(accu, node) {
-        // Add node to buffer
-        buffer.push(node);
-
-        // Flush buffer once we hit the end of a question
-        if(node.type === 'blockquote_end') {
-            accu.push(buffer);
-            // Clear buffer
-            buffer = [];
-        }
-
-        return accu;
-    }, []);
-}
-
-function isQuiz(nodes) {
-    // Extract potential questions
-    var questions = splitQuestions(
-        // Skip quiz title if there
-        nodes.slice(
-            (nodes[0] && nodes[0].type) === 'paragraph' ? 1 : 0
-        )
-    );
-
-    // Nothing that looks like questions
-    if(questions.length === 0) {
-        return false;
-    }
-
-    // Ensure all questions are correctly structured
-    return _.all(questions, isQuestion);
-}
-
-module.exports = isQuiz;

lib/parse/langs.js

@@ -1,25 +0,0 @@
-var _ = require("lodash");
-var parseEntries = require("./summary").entries;
-
-
-var parseLangs = function(content) {
-    var entries = parseEntries(content);
-
-    return {
-        list: _.chain(entries)
-            .filter(function(entry) {
-                return Boolean(entry.path);
-            })
-            .map(function(entry) {
-                return {
-                    title: entry.title,
-                    path: entry.path,
-                    lang: entry.path.replace("/", "")
-                };
-            })
-            .value()
-    };
-};
-
-
-module.exports = parseLangs;

lib/parse/lex.js

@@ -1,79 +0,0 @@
-var _ = require('lodash');
-var kramed = require('kramed');
-
-var isExercise = require('./is_exercise');
-var isQuiz = require('./is_quiz');
-
-// Split a page up into sections (lesson, exercises, ...)
-function splitSections(nodes) {
-    var section = [];
-
-    return _.reduce(nodes, function(sections, el) {
-        if(el.type === 'hr') {
-            sections.push(section);
-            section = [];
-        } else {
-            section.push(el);
-        }
-
-        return sections;
-    }, []).concat([section]); // Add remaining nodes
-}
-
-// What is the type of this section
-function sectionType(nodes, idx) {
-    if(isExercise(nodes)) {
-        return 'exercise';
-    } else if(isQuiz(nodes)) {
-        return 'quiz';
-    }
-
-    return 'normal';
-}
-
-// Generate a uniqueId to identify this section in our code
-function sectionId(section, idx) {
-    return _.uniqueId('gitbook_');
-}
-
-function lexPage(src) {
-    // Lex file
-    var nodes = kramed.lexer(src);
-
-    return _.chain(splitSections(nodes))
-    .map(function(section, idx) {
-        // Detect section type
-        section.type = sectionType(section, idx);
-        return section;
-    })
-    .map(function(section, idx) {
-        // Give each section an ID
-        section.id = sectionId(section, idx);
-        return section;
-
-    })
-    .filter(function(section) {
-        return !_.isEmpty(section);
-    })
-    .reduce(function(sections, section) {
-        var last = _.last(sections);
-
-        // Merge normal sections together
-        if(last && last.type === section.type && last.type === 'normal') {
-            last.push.apply(last, [{'type': 'hr'}].concat(section));
-        } else {
-            // Add to list of sections
-            sections.push(section);
-        }
-
-        return sections;
-    }, [])
-    .map(function(section) {
-        section.links = nodes.links;
-        return section;
-    })
-    .value();
-}
-
-// Exports
-module.exports = lexPage;

lib/parse/navigation.js

@@ -1,64 +0,0 @@
-var _ = require('lodash');
-
-// Cleans up an article/chapter object
-// remove 'articles' attributes
-function clean(obj) {
-    return obj && _.omit(obj, ['articles']);
-}
-
-function flattenChapters(chapters) {
-    return _.reduce(chapters, function(accu, chapter) {
-        return accu.concat([clean(chapter)].concat(flattenChapters(chapter.articles)));
-    }, []);
-}
-
-// Returns from a summary a map of
-/*
-    {
-        "file/path.md": {
-            prev: ...,
-            next: ...,
-        },
-        ...
-    }
-*/
-function navigation(summary, files) {
-    // Support single files as well as list
-    files = _.isArray(files) ? files : (_.isString(files) ? [files] : null);
-
-    // List of all navNodes
-    // Flatten chapters, then add in default README node if ndeeded etc ...
-    var navNodes = flattenChapters(summary.chapters);
-    var prevNodes = [null].concat(navNodes.slice(0, -1));
-    var nextNodes = navNodes.slice(1).concat([null]);
-
-    // Mapping of prev/next for a give path
-    var mapping = _.chain(_.zip(navNodes, prevNodes, nextNodes))
-    .map(function(nodes) {
-        var current = nodes[0], prev = nodes[1], next = nodes[2];
-
-        // Skip if no path
-        if(!current.path) return null;
-
-        return [current.path, {
-            title: current.title,
-            prev: prev,
-            next: next,
-            level: current.level,
-        }];
-    })
-    .filter()
-    .object()
-    .value();
-
-    // Filter for only files we want
-    if(files) {
-        return _.pick(mapping, files);
-    }
-
-    return mapping;
-}
-
-
-// Exports
-module.exports = navigation;

lib/parse/page.js

@@ -1,160 +0,0 @@
-var _ = require('lodash');
-var kramed = require('kramed');
-var hljs = require('highlight.js');
-
-var lex = require('./lex');
-var renderer = require('./renderer');
-
-var include = require('./include');
-var lnormalize = require('../utils/lang').normalize;
-
-
-
-// Render a section using our custom renderer
-function render(section, _options) {
-    // Copy section
-    var links = section.links || {};
-    section = _.toArray(section);
-    section.links = links;
-
-    // Build options using defaults and our custom renderer
-    var options = _.extend({}, kramed.defaults, {
-        renderer: renderer(null, _options),
-
-        // Synchronous highlighting with highlight.js
-        highlight: function (code, lang) {
-            if(!lang) return code;
-
-            // Normalize lang
-            lang = lnormalize(lang);
-
-            try {
-                return hljs.highlight(lang, code).value;
-            } catch(e) { }
-
-            return code;
-        }
-    });
-
-    return kramed.parser(section, options);
-}
-
-function quizQuestion(node) {
-    if (node.text) {
-        node.text = node.text.replace(/^([\[(])x([\])])/, "$1 $2");
-    } else {
-        return node.replace(/^([\[(])x([\])])/, "$1 $2");
-    }
-}
-
-function parsePage(src, options) {
-    options = options || {};
-
-    // Lex if not already lexed
-    var parsed = {
-        lexed: (_.isArray(src) ? src : lex(include(src, options.includer || function() { return undefined; })))
-    };
-    parsed.sections = parsed.lexed.map(function(section) {
-        // Transform given type
-        if(section.type === 'exercise') {
-            var nonCodeNodes = _.reject(section, {
-                'type': 'code'
-            });
-
-            var codeNodes = _.filter(section, {
-                'type': 'code'
-            });
-
-            // Languages in code blocks
-            var langs = _.pluck(codeNodes, 'lang').map(lnormalize);
-
-            // Check that they are all the same
-            var validLangs = _.all(_.map(langs, function(lang) {
-                return lang && lang === langs[0];
-            }));
-
-            // Main language
-            var lang = validLangs ? langs[0] : null;
-
-            return {
-                id: section.id,
-                type: section.type,
-                content: render(nonCodeNodes, options),
-                lang: lang,
-                code: {
-                    base: codeNodes[0].text,
-                    solution: codeNodes[1].text,
-                    validation: codeNodes[2].text,
-                    // Context is optional
-                    context: codeNodes[3] ? codeNodes[3].text : null,
-                }
-            };
-        } else if (section.type === 'quiz') {
-            var quiz = [], question, foundFeedback = false;
-            var nonQuizNodes = section[0].type === 'paragraph' && section[1].type !== 'list_start' ? [section[0]] : [];
-            var quizNodes = section.slice(0);
-            quizNodes.splice(0, nonQuizNodes.length);
-
-            for (var i = 0; i < quizNodes.length; i++) {
-                var node = quizNodes[i];
-
-                if (question && (((node.type === 'list_end' || node.type === 'blockquote_end') && i === quizNodes.length - 1)
-                                 || node.type === 'table' || (node.type === 'paragraph' && !foundFeedback))) {
-                    quiz.push({
-                        base: render(question.questionNodes, options),
-                        solution: render(question.solutionNodes, options),
-                        feedback: render(question.feedbackNodes, options)
-                    });
-                }
-
-                if (node.type === 'table' || (node.type === 'paragraph' && !foundFeedback)) {
-                    question = { questionNodes: [], solutionNodes: [], feedbackNodes: [] };
-                }
-
-                if (node.type === 'blockquote_start') {
-                    foundFeedback = true;
-                } else if (node.type === 'blockquote_end') {
-                    foundFeedback = false;
-                }
-
-                if (node.type === 'table') {
-                    question.solutionNodes.push(_.cloneDeep(node));
-                    node.cells = node.cells.map(function(row) {
-                        return row.map(quizQuestion);
-                    });
-                    question.questionNodes.push(node);
-                } else if (!/blockquote/.test(node.type)) {
-                    if (foundFeedback) {
-                        question.feedbackNodes.push(node);
-                    } else if (node.type === 'paragraph' || node.type === 'text'){
-                        question.solutionNodes.push(_.cloneDeep(node));
-                        quizQuestion(node);
-                        question.questionNodes.push(node);
-                    } else {
-                        question.solutionNodes.push(node);
-                        question.questionNodes.push(node);
-                    }
-                }
-            }
-
-            return {
-                id: section.id,
-                type: section.type,
-                content: render(nonQuizNodes, options),
-                quiz: quiz
-            };
-        }
-
-        // Render normal pages
-        return {
-            id: section.id,
-            type: section.type,
-            content: render(section, options)
-        };
-    });
-
-    return parsed;
-}
-
-// Exports
-module.exports = parsePage;

lib/parse/progress.js

@@ -1,47 +0,0 @@
-var _ = require("lodash");
-
-// Returns from a navigation and a current file, a snapshot of current detailed state
-var calculProgress = function(navigation, current) {
-    var n = _.size(navigation);
-    var percent = 0, prevPercent = 0, currentChapter = null;
-    var done = true;
-
-    var chapters = _.chain(navigation)
-    .map(function(nav, path) {
-        nav.path = path;
-        return nav;
-    })
-    .map(function(nav, i) {
-        // Calcul percent
-        nav.percent = (i * 100) / Math.max((n - 1), 1);
-
-        // Is it done
-        nav.done = done;
-        if (nav.path == current) {
-            currentChapter = nav;
-            percent = nav.percent;
-            done = false;
-        } else if (done) {
-            prevPercent = nav.percent;
-        }
-
-        return nav;
-    })
-    .value();
-
-    return {
-        // Previous percent
-        prevPercent: prevPercent,
-
-        // Current percent
-        percent: percent,
-
-        // List of chapter with progress
-        chapters: chapters,
-
-        // Current chapter
-        current: currentChapter
-    };
-}
-
-module.exports = calculProgress;

lib/parse/readme.js

@@ -1,45 +0,0 @@
-var _ = require('lodash');
-var kramed = require('kramed');
-var textRenderer = require('kramed-text-renderer');
-
-function extractFirstNode(nodes, nType) {
-    return _.chain(nodes)
-    .filter(function(node) {
-        return node.type == nType;
-    })
-    .pluck("text")
-    .first()
-    .value();
-}
-
-
-function parseReadme(src) {
-    var nodes, title, description;
-    var renderer = textRenderer();
-
-    // Parse content
-    nodes = kramed.lexer(src);
-
-    title = extractFirstNode(nodes, "heading") || '';
-    description = extractFirstNode(nodes, "paragraph") || '';
-
-    var convert = _.compose(
-        function(text) {
-            return _.unescape(text.replace(/(\r\n|\n|\r)/gm, ""));
-        },
-        function(text) {
-            return kramed.parse(text, _.extend({}, kramed.defaults, {
-                renderer: renderer
-            }));
-        }
-    );
-
-    return {
-        title: convert(title),
-        description: convert(description)
-    };
-}
-
-
-// Exports
-module.exports = parseReadme;

lib/parse/renderer.js

@@ -1,141 +0,0 @@
-var url = require('url');
-var _ = require('lodash');
-var inherits = require('util').inherits;
-var links = require('../utils').links;
-var kramed = require('kramed');
-
-var rendererId = 0;
-
-function GitBookRenderer(options, extra_options) {
-    if(!(this instanceof GitBookRenderer)) {
-        return new GitBookRenderer(options, extra_options);
-    }
-    GitBookRenderer.super_.call(this, options);
-
-    this._extra_options = extra_options;
-    this.quizRowId = 0;
-    this.id = rendererId++;
-    this.quizIndex = 0;
-}
-inherits(GitBookRenderer, kramed.Renderer);
-
-GitBookRenderer.prototype._unsanitized = function(href) {
-    var prot = '';
-    try {
-        prot = decodeURIComponent(unescape(href))
-            .replace(/[^\w:]/g, '')
-            .toLowerCase();
-
-    } catch (e) {
-        return true;
-    }
-
-    if(prot.indexOf('javascript:') === 0) {
-        return true;
-    }
-
-    return false;
-};
-
-GitBookRenderer.prototype.link = function(href, title, text) {
-    // Our "fixed" href
-    var _href = href;
-
-    // Don't build if it looks malicious
-    if (this.options.sanitize && this._unsanitized(href)) {
-        return text;
-    }
-
-    // Parsed version of the url
-    var parsed = url.parse(href);
-    var o = this._extra_options;
-    var extname = parsed.path? _.last(parsed.path.split(".")) : "";
-
-    // Relative link, rewrite it to point to github repo
-    if(links.isRelative(_href) && extname == "md") {
-        _href = links.toAbsolute(_href, o.dir || "./", o.outdir || "./");
-        _href = _href.replace(".md", ".html");
-    }
-
-    // Generate HTML for link
-    var out = '<a href="' + _href + '"';
-    // Title if no null
-    if (title) {
-        out += ' title="' + title + '"';
-    }
-    // Target blank if external
-    if(parsed.protocol) {
-        out += ' target="_blank"';
-    }
-    out += '>' + text + '</a>';
-    return out;
-};
-
-GitBookRenderer.prototype.image = function(href, title, text) {
-    // Our "fixed" href
-    var _href = href;
-
-    // Parsed version of the url
-    var parsed = url.parse(href);
-
-    // Options
-    var o = this._extra_options;
-
-    // Relative image, rewrite it depending output
-    if(links.isRelative(href) && o && o.dir && o.outdir) {
-        // o.dir: directory parent of the file currently in rendering process
-        // o.outdir: directory parent from the html output
-
-        _href = links.toAbsolute(_href, o.dir, o.outdir);
-    }
-
-    return GitBookRenderer.super_.prototype.image.call(this, _href, title, text);
-};
-
-GitBookRenderer.prototype.tablerow = function(content) {
-    this.quizRowId += 1;
-    return GitBookRenderer.super_.prototype.tablerow(content);
-};
-
-var fieldRegex = /^([(\[])([ x])[\])]/;
-GitBookRenderer.prototype._createCheckboxAndRadios = function(text) {
-    var match = fieldRegex.exec(text);
-    if (!match) {
-        return text;
-    }
-    //fix radio input uncheck failed
-    var quizFieldName='quiz-row-' + this.id + '-' + this.quizRowId ;
-    var quizIdentifier = quizFieldName + '-' + this.quizIndex++;
-    var field = "<input name='" + quizFieldName + "' id='" + quizIdentifier + "' type='";
-    field += match[1] === '(' ? "radio" : "checkbox";
-    field += match[2] === 'x' ? "' checked/>" : "'/>";
-    var splittedText = text.split(fieldRegex);
-    var length = splittedText.length;
-    var label = '<label class="quiz-label" for="' + quizIdentifier + '">' + splittedText[length - 1] + '</label>';
-    return text.replace(fieldRegex, field).replace(splittedText[length - 1], label);
-};
-
-GitBookRenderer.prototype.tablecell = function(content, flags) {
-    return GitBookRenderer.super_.prototype.tablecell(this._createCheckboxAndRadios(content), flags);
-};
-
-GitBookRenderer.prototype.listitem = function(text) {
-    return GitBookRenderer.super_.prototype.listitem(this._createCheckboxAndRadios(text));
-};
-
-GitBookRenderer.prototype.code = function(code, lang, escaped) {
-    return GitBookRenderer.super_.prototype.code.call(
-        this,
-        code,
-        lang,
-        escaped
-    );
-};
-
-GitBookRenderer.prototype.heading = function(text, level, raw) {
-    var id = this.options.headerPrefix + raw.toLowerCase().replace(/[^\w -]+/g, '').replace(/ /g, '-');
-    return '<h' + level + ' id="' + id + '">' + text + '</h' + level + '>\n';
-};
-
-// Exports
-module.exports = GitBookRenderer;

lib/parse/summary.js

@@ -1,148 +0,0 @@
-var _ = require('lodash');
-var kramed = require('kramed');
-
-
-// Utility function for splitting a list into groups
-function splitBy(list, starter, ender) {
-    var starts = 0;
-    var ends = 0;
-    var group = [];
-
-    // Groups
-    return _.reduce(list, function(groups, value) {
-        // Ignore start and end delimiters in resulted groups
-        if(starter(value)) {
-            starts++;
-        } else if(ender(value)) {
-            ends++;
-        }
-
-        // Add current value to group
-        group.push(value);
-
-        // We've got a matching
-        if(starts === ends && starts !== 0) {
-            // Add group to end groups
-            // (remove starter and ender token)
-            groups.push(group.slice(1, -1));
-
-            // Reset group
-            group = [];
-        }
-
-        return groups;
-    }, []);
-}
-
-function listSplit(nodes, start_type, end_type) {
-    return splitBy(nodes, function(el) {
-        return el.type === start_type;
-    }, function(el) {
-        return el.type === end_type;
-    });
-}
-
-// Get the biggest list
-// out of a list of kramed nodes
-function filterList(nodes) {
-    return _.chain(nodes)
-    .toArray()
-    .rest(function(el) {
-        // Get everything after list_start
-        return el.type !== 'list_start';
-    })
-    .reverse()
-    .rest(function(el) {
-        // Get everything after list_end (remember we're reversed)
-        return el.type !== 'list_end';
-    })
-    .reverse()
-    .value().slice(1, -1);
-}
-
-// Parses an Article or Chapter title
-// supports extracting links
-function parseTitle(src, nums) {
-    // Check if it's a link
-    var matches = kramed.InlineLexer.rules.link.exec(src);
-
-    var level = nums.join('.');
-
-    // Not a link, return plain text
-    if(!matches) {
-        return {
-            title: src,
-            level: level,
-            path: null,
-        };
-    }
-
-    return {
-        title: matches[1],
-        level: level,
-
-        // Normalize path
-        // 1. Convert Window's "\" to "/"
-        // 2. Remove leading "/" if exists
-        path: matches[2].replace(/\\/g, '/').replace(/^\/+/, ''),
-    };
-}
-
-function parseChapter(nodes, nums) {
-    // Convert single number to an array
-    nums = _.isArray(nums) ? nums : [nums];
-
-    return _.extend(parseTitle(_.first(nodes).text, nums), {
-        articles: _.map(listSplit(filterList(nodes), 'list_item_start', 'list_item_end'), function(nodes, i) {
-            return parseChapter(nodes, nums.concat(i + 1));
-        })
-    });
-}
-
-function defaultChapterList(chapterList) {
-    var first = _.first(chapterList);
-
-    // Check if introduction node was specified in SUMMARY.md
-    if (first) {
-        var chapter = parseChapter(first, [0]);
-
-        // Already have README node, we're good to go
-        if(chapter.path === 'README.md') {
-            return chapterList;
-        }
-    }
-
-    // It wasn't specified, so add in default
-    return [
-        [ { type: 'text', text: '[Introduction](README.md)' } ]
-    ].concat(chapterList);
-}
-
-function listGroups(src) {
-    var nodes = kramed.lexer(src);
-
-    // Get out groups of lists
-    return listSplit(
-        filterList(nodes),
-        'list_item_start', 'list_item_end'
-    );
-}
-
-function parseSummary(src) {
-    // Split out chapter sections
-    var chapters = defaultChapterList(listGroups(src))
-    .map(parseChapter);
-
-    return {
-        chapters: chapters
-    };
-}
-
-function parseEntries (src) {
-    return listGroups(src).map(parseChapter);
-}
-
-
-// Exports
-module.exports = parseSummary;
-module.exports.entries = parseEntries;

lib/utils/index.js

@@ -1,4 +0,0 @@
-module.exports = {
-    lang: require('./lang'),
-    links: require('./links')
-};

lib/utils/lang.js

@@ -1,19 +0,0 @@
-var MAP = {
-    'py': 'python',
-    'js': 'javascript',
-    'rb': 'ruby',
-    'csharp': 'cs',
-};
-
-function normalize(lang) {
-    if(!lang) { return null; }
-
-    var lower = lang.toLowerCase();
-    return MAP[lower] || lower;
-}
-
-// Exports
-module.exports = {
-    normalize: normalize,
-    MAP: MAP
-};

lib/utils/links.js

@@ -1,60 +0,0 @@
-var url = require('url');
-var path = require('path');
-
-// Is the link an external link
-var isExternal = function(href) {
-    try {
-        return Boolean(url.parse(href).protocol);
-    } catch(err) { }
-
-    return false;
-};
-
-// Return true if the link is relative
-var isRelative = function(href) {
-    try {
-        var parsed = url.parse(href);
-
-        return !parsed.protocol && parsed.path && parsed.path[0] != '/';
-    } catch(err) {}
-
-    return true;
-};
-
-// Relative to absolute path
-// dir: directory parent of the file currently in rendering process
-// outdir: directory parent from the html output
-
-var toAbsolute = function(_href, dir, outdir) {
-    // Absolute file in source
-    _href = path.join(dir, _href);
-
-    // make it relative to output
-    _href = path.relative(outdir, _href);
-
-    if (process.platform === 'win32') {
-        _href = _href.replace(/\\/g, '/');
-    }
-
-    return _href;
-};
-
-// Join links
-
-var join = function() {
-    var _href = path.join.apply(path, arguments);
-
-    if (process.platform === 'win32') {
-        _href = _href.replace(/\\/g, '/');
-    }
-
-    return _href;
-};
-
-
-module.exports = {
-    isRelative: isRelative,
-    isExternal: isExternal,
-    toAbsolute: toAbsolute,
-    join: join
-};

lib/utils/string.js

@@ -1,26 +0,0 @@
-var _ = require("lodash");
-
-function escapeShellArg(arg) {
-    var ret = '';
-
-    ret = arg.replace(/"/g, '\\"');
-
-    return "\"" + ret + "\"";
-}
-
-function optionsToShellArgs(options) {
-    return _.chain(options)
-    .map(function(value, key) {
-        if (value == null || value === false) return null;
-        if (value === true) return key;
-        return key+"="+escapeShellArg(value);
-    })
-    .compact()
-    .value()
-    .join(" ");
-}
-
-module.exports = {
-    escapeShellArg: escapeShellArg,
-    optionsToShellArgs: optionsToShellArgs
-};

package.json

@@ -1,72 +1,26 @@
 {
-    "name": "gitbook",
-    "version": "1.3.3",
-    "homepage": "http://www.gitbook.io/",
-    "description": "Library and cmd utility to generate GitBooks",
-    "main": "lib/index.js",
-    "dependencies": {
-        "q": "1.0.1",
-        "lodash": "2.4.1",
-        "kramed": "0.4.3",
-        "kramed-text-renderer": "0.2.1",
-        "lunr": "0.5.2",
-        "swig": "1.3.2",
-        "send": "0.2.0",
-        "fstream-ignore": "0.0.7",
-        "commander": "2.2.0",
-        "graceful-fs": "3.0.2",
-        "fs-extra": "0.10.0",
-        "highlight.js": "8.3.0",
-        "tmp": "0.0.23",
-        "semver": "2.2.1",
-        "gaze": "~0.5.1",
-        "resolve": "0.6.3",
-        "tiny-lr-fork": "0.0.5",
-        "gitbook-plugin": "0.0.2",
-        "gitbook-plugin-mathjax": "0.0.6",
-        "gitbook-plugin-livereload": "0.0.1",
-        "gitbook-plugin-exercises": "1.0.0",
-        "gitbook-plugin-quizzes": "1.0.0"
-    },
-    "devDependencies": {
-        "mocha": "1.18.2",
-        "grunt": "~0.4.2",
-        "grunt-cli": "0.1.11",
-        "grunt-contrib-copy": "0.5.0",
-        "grunt-contrib-less": "~0.5.0",
-        "grunt-contrib-requirejs": "0.4.1",
-        "grunt-bower-install-simple": "0.9.2",
-        "grunt-browserify": "3.1.0",
-        "grunt-contrib-uglify": "0.6.0"
-    },
-    "scripts": {
-        "test": "export TESTING=true; mocha --reporter list"
-    },
-    "bin": {
-        "gitbook": "./bin/gitbook.js"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/GitbookIO/gitbook.git"
-    },
-    "keywords": [
-        "git",
-        "book",
-        "gitbook"
-    ],
-    "author": "FriendCode <contact@friendco.de>",
-    "license": "Apache 2",
-    "bugs": {
-        "url": "https://github.com/GitbookIO/gitbook/issues"
-    },
-    "contributors": [
-        {
-            "name": "Aaron O'Mullan",
-            "email": "aaron.omullan@gmail.com"
-        },
-        {
-            "name": "Samy Pessé",
-            "email": "samypesse@gmail.com"
-        }
-    ]
+  "private": true,
+  "devDependencies": {
+    "eslint": "3.12.2",
+    "eslint-config-gitbook": "1.5.0",
+    "lerna": "2.0.0-beta.31"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "test": "lerna run --concurrency 1 test",
+    "bootstrap": "npm run bump && lerna bootstrap",
+    "bump": "./scripts/bump.js",
+    "clean": "lerna clean",
+    "dist": "lerna run --concurrency 1 prepublish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GitbookIO/gitbook.git"
+  },
+  "author": "GitBook Inc. <contact@gitbook.com>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/GitbookIO/gitbook/issues"
+  },
+  "homepage": "https://github.com/GitbookIO/gitbook#readme"
 }

packages/gitbook-core/.babelrc

@@ -0,0 +1,3 @@
+{
+    "presets": ["es2015", "react", "stage-2"]
+}

packages/gitbook-core/.gitignore

@@ -0,0 +1 @@
+gitbook.core.min.js

packages/gitbook-core/.npmignore

@@ -0,0 +1,3 @@
+src
+!lib
+!dist

packages/gitbook-core/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "gitbook-core",
+  "version": "4.0.0-alpha.2",
+  "description": "Core for GitBook plugins API",
+  "main": "./lib/index.js",
+  "dependencies": {
+    "bluebird": "^3.4.6",
+    "classnames": "^2.2.5",
+    "entities": "^1.1.1",
+    "history": "^4.3.0",
+    "html-tags": "^1.1.1",
+    "immutable": "^3.8.1",
+    "mousetrap": "1.6.0",
+    "react": "15.4.1",
+    "react-addons-css-transition-group": "15.4.1",
+    "react-dom": "15.4.1",
+    "react-helmet": "^3.1.0",
+    "react-immutable-proptypes": "^2.1.0",
+    "react-intl": "^2.1.5",
+    "react-redux": "^4.4.5",
+    "react-safe-html": "0.4.0",
+    "redux": "^3.5.2",
+    "redux-thunk": "^2.1.0",
+    "reflexbox": "^2.2.2",
+    "whatwg-fetch": "^1.0.0"
+  },
+  "devDependencies": {
+    "babel-cli": "^6.14.0",
+    "babel-preset-es2015": "^6.14.0",
+    "babel-preset-react": "^6.11.1",
+    "babel-preset-stage-2": "^6.13.0",
+    "browserify": "^13.1.0",
+    "envify": "^3.4.1",
+    "uglify-js": "^2.7.3"
+  },
+  "scripts": {
+    "dist-lib": "rm -rf lib/ && babel -d lib/ src/",
+    "dist-standalone": "mkdir -p dist && browserify -r ./lib/index.js:gitbook-core -r react -r react-dom ./lib/index.js | uglifyjs -c > ./dist/gitbook.core.min.js",
+    "dist": "npm run dist-lib && npm run dist-standalone",
+    "prepublish": "npm run dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GitbookIO/gitbook.git"
+  },
+  "author": "GitBook Inc. <contact@gitbook.com>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/GitbookIO/gitbook/issues"
+  }
+}

packages/gitbook-core/src/actions/TYPES.js

@@ -0,0 +1,16 @@
+
+module.exports = {
+    // Components
+    REGISTER_COMPONENT:   'components/register',
+    UNREGISTER_COMPONENT: 'components/unregister',
+    // Navigation
+    HISTORY_ACTIVATE:     'history/activate',
+    HISTORY_DEACTIVATE:   'history/deactivate',
+    HISTORY_LISTEN:       'history/listen',
+    HISTORY_UPDATE:       'history/update',
+    PAGE_FETCH_START:     'history/fetch:start',
+    PAGE_FETCH_END:       'history/fetch:end',
+    PAGE_FETCH_ERROR:     'history/fetch:error',
+    // i18n
+    I18N_REGISTER_LOCALE: 'i18n/register:locale'
+};

packages/gitbook-core/src/actions/components.js

@@ -0,0 +1,37 @@
+const ACTION_TYPES = require('./TYPES');
+
+/**
+ * Find all components matching a descriptor
+ * @param {List<ComponentDescriptor>} state
+ * @param {String} matching.role
+ */
+function findMatchingComponents(state, matching) {
+    return state
+    .filter(({descriptor}) => {
+        if (matching.role && matching.role !== descriptor.role) {
+            return false;
+        }
+
+        return true;
+    })
+    .map(component => component.Component);
+}
+
+/**
+ * Register a new component
+ * @param  {React.Class} Component
+ * @param  {Descriptor} descriptor
+ * @return {Action}
+ */
+function registerComponent(Component, descriptor) {
+    return {
+        type: ACTION_TYPES.REGISTER_COMPONENT,
+        Component,
+        descriptor
+    };
+}
+
+module.exports = {
+    findMatchingComponents,
+    registerComponent
+};

packages/gitbook-core/src/actions/history.js

@@ -0,0 +1,188 @@
+const ACTION_TYPES = require('./TYPES');
+const getPayload = require('../lib/getPayload');
+const Location = require('../models/Location');
+
+const SUPPORTED = (
+    typeof window !== 'undefined' &&
+    window.history && window.history.pushState && window.history.replaceState &&
+    // pushState isn't reliable on iOS until 5.
+    !navigator.userAgent.match(/((iPod|iPhone|iPad).+\bOS\s+[1-4]\D|WebApps\/.+CFNetwork)/)
+);
+
+/**
+ * Initialize the history
+ */
+function activate() {
+    return (dispatch, getState) => {
+        dispatch({
+            type: ACTION_TYPES.HISTORY_ACTIVATE,
+            listener: (location) => {
+                location = Location.fromNative(location);
+                const prevLocation = getState().history.location;
+
+                // Fetch page if required
+                if (!prevLocation || location.pathname !== prevLocation.pathname) {
+                    dispatch(fetchPage(location.pathname));
+                }
+
+                // Signal location to listener
+                dispatch(emit());
+
+                // Update the location
+                dispatch({
+                    type: ACTION_TYPES.HISTORY_UPDATE,
+                    location
+                });
+            }
+        });
+
+        // Trigger for existing listeners
+        dispatch(emit());
+    };
+}
+
+/**
+ * Emit current location
+ * @param {List|Array<Function>} to?
+ */
+function emit(to) {
+    return (dispatch, getState) => {
+        const { listeners, client } = getState().history;
+
+        if (!client) {
+            return;
+        }
+
+        const location = Location.fromNative(client.location);
+
+        to = to || listeners;
+
+        to.forEach(handler => {
+            handler(location, dispatch, getState);
+        });
+    };
+}
+
+/**
+ * Cleanup the history
+ */
+function deactivate() {
+    return { type: ACTION_TYPES.HISTORY_DEACTIVATE };
+}
+
+/**
+ * Push a new url into the history
+ * @param {String|Location} location
+ * @return {Action} action
+ */
+function push(location) {
+    return (dispatch, getState) => {
+        const { client } = getState().history;
+        location = Location.fromNative(location);
+
+        if (SUPPORTED) {
+            client.push(location.toNative());
+        } else {
+            redirect(location.toString());
+        }
+    };
+}
+
+/**
+ * Replace current state in history
+ * @param {String|Location} location
+ * @return {Action} action
+ */
+function replace(location) {
+    return (dispatch, getState) => {
+        const { client } = getState().history;
+        location = Location.fromNative(location);
+
+        if (SUPPORTED) {
+            client.replace(location.toNative());
+        } else {
+            redirect(location.toString());
+        }
+    };
+}
+
+/**
+ * Hard redirection
+ * @param {String} uri
+ * @return {Action} action
+ */
+function redirect(uri) {
+    return () => {
+        window.location.href = uri;
+    };
+}
+
+/**
+ * Listen to url change
+ * @param {Function} listener
+ * @return {Action} action
+ */
+function listen(listener) {
+    return (dispatch, getState) => {
+        dispatch({ type: ACTION_TYPES.HISTORY_LISTEN, listener });
+
+        // Trigger for existing listeners
+        dispatch(emit([ listener ]));
+    };
+}
+
+/**
+ * Fetch a new page and update the store accordingly
+ * @param {String} pathname
+ * @return {Action} action
+ */
+function fetchPage(pathname) {
+    return (dispatch, getState) => {
+        dispatch({ type: ACTION_TYPES.PAGE_FETCH_START });
+
+        window.fetch(pathname, {
+            credentials: 'include'
+        })
+        .then(
+            response => {
+                return response.text();
+            }
+        )
+        .then(
+            html => {
+                const payload = getPayload(html);
+
+                if (!payload) {
+                    throw new Error('No payload found in page');
+                }
+
+                dispatch({ type: ACTION_TYPES.PAGE_FETCH_END, payload });
+            }
+        )
+        .catch(
+            error => {
+                // dispatch(redirect(pathname));
+                dispatch({ type: ACTION_TYPES.PAGE_FETCH_ERROR, error });
+            }
+        );
+    };
+}
+
+/**
+ * Fetch a new article
+ * @param {SummaryArticle} article
+ * @return {Action} action
+ */
+function fetchArticle(article) {
+    return fetchPage(article.path);
+}
+
+module.exports = {
+    activate,
+    deactivate,
+    listen,
+    push,
+    replace,
+    fetchPage,
+    fetchArticle
+};

packages/gitbook-core/src/actions/i18n.js

@@ -0,0 +1,33 @@
+const ACTION_TYPES = require('./TYPES');
+
+/**
+ * Register messages for a locale
+ * @param {String} locale
+ * @param {Map<String:String>} messages
+ * @return {Action}
+ */
+function registerLocale(locale, messages) {
+    return { type: ACTION_TYPES.I18N_REGISTER_LOCALE, locale, messages };
+}
+
+/**
+ * Register multiple locales
+ * @param {Map<String:Object>} locales
+ * @return {Action}
+ */
+function registerLocales(locales) {
+    return (dispatch) => {
+        for (const locale in locales) {
+            if (!locales.hasOwnProperty(locale)) {
+                continue;
+            }
+
+            dispatch(registerLocale(locale, locales[locale]));
+        }
+    };
+}
+
+module.exports = {
+    registerLocale,
+    registerLocales
+};

packages/gitbook-core/src/components/Backdrop.js

@@ -0,0 +1,56 @@
+const React = require('react');
+const HotKeys = require('./HotKeys');
+
+/**
+ * Backdrop for modals, dropdown, etc. that covers the whole screen
+ * and handles click and pressing escape.
+ *
+ * <Backdrop onClose={onCloseModal} />
+ */
+const Backdrop = React.createClass({
+    propTypes: {
+        // Callback when backdrop is closed
+        onClose:  React.PropTypes.func.isRequired,
+        // Z-index for the backdrop
+        zIndex:   React.PropTypes.number,
+        children: React.PropTypes.node
+    },
+
+    getDefaultProps() {
+        return {
+            zIndex: 200
+        };
+    },
+
+    onClick(event) {
+        const { onClose } = this.props;
+
+        event.preventDefault();
+        event.stopPropagation();
+
+        onClose();
+    },
+
+    render() {
+        const { zIndex, children, onClose } = this.props;
+        const style = {
+            zIndex,
+            position: 'fixed',
+            top: 0,
+            right: 0,
+            width: '100%',
+            height: '100%'
+        };
+        const keyMap = {
+            'escape': onClose
+        };
+
+        return (
+            <HotKeys keyMap={keyMap}>
+                <div style={style} onClick={this.onClick}>{children}</div>
+            </HotKeys>
+        );
+    }
+});
+
+module.exports = Backdrop;

packages/gitbook-core/src/components/Button.js

@@ -0,0 +1,22 @@
+const React = require('react');
+const classNames = require('classnames');
+
+const Button = React.createClass({
+    propTypes: {
+        active:    React.PropTypes.bool,
+        className: React.PropTypes.string,
+        children:  React.PropTypes.node,
+        onClick:   React.PropTypes.func
+    },
+
+    render() {
+        const { children, active, onClick } = this.props;
+        const className = classNames('GitBook-Button', this.props.className, {
+            active
+        });
+
+        return <button className={className} onClick={onClick}>{children}</button>;
+    }
+});
+
+module.exports = Button;

packages/gitbook-core/src/components/ButtonGroup.js

@@ -0,0 +1,23 @@
+const React = require('react');
+const classNames = require('classnames');
+
+const ButtonGroup = React.createClass({
+    propTypes: {
+        className: React.PropTypes.string,
+        children:  React.PropTypes.node,
+        onClick:   React.PropTypes.func
+    },
+
+    render() {
+        let { className, children } = this.props;
+
+        className = classNames(
+            'GitBook-ButtonGroup',
+            className
+        );
+
+        return <div className={className}>{children}</div>;
+    }
+});
+
+module.exports = ButtonGroup;