Added generic documentation

Author: apidevrb

api-design/aws/Instructions.md renamed to api-tool/aws/Instructions.md

@@ -0,0 +1,25 @@
+# GitBook Toolchain Documentation
+
+This document aims to be a comprehensive guide to the GitBook command line tool, version **3.2.3**. This is the same toolchain used by the legacy GitBook platform, living at legacy.gitbook.com. Help for using the platform can be found at [help.legacy.gitbook.com](https://help.legacy.gitbook.com). If you are looking for the new GitBook service, head to [gitbook.com](https://www.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).
+
+[legacy.gitbook.com](https://legacy.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://legacy.gitbook.com/editor).
+
+### Help and Support
+
+If you have problems with the toolchain, you can search for or open a discussion on [GitHub](https://github.com/GitbookIO/gitbook).
+
+Check out the [GitBook Community Slack Channel](https://slack.gitbook.com) for help, and 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.

api-design/aws/openshift/Instructions.md renamed to api-tool/aws/openshift/Instructions.md

@@ -0,0 +1,50 @@
+# 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)
+    * [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)
+
+--
+
+* [FAQ](faq.md)
+* [Examples](examples.md)
+* [Release notes](https://github.com/GitbookIO/gitbook/blob/master/CHANGES.md)
+
+

api-design/aws/openshift/ansible/Instructions.md renamed to api-tool/aws/openshift/ansible/Instructions.md

@@ -0,0 +1,26 @@
+{% extends template.self %}
+
+{% block header_nav %}
+<a href="https://github.com/GitbookIO/gitbook/blob/master/docs/{{ file.path }}" target="_blank" class="btn btn-link pull-right hidden-xs">
+    <i class="octicon octicon-mark-github"></i> Edit on GitHub
+</a>
+<a href="{{ "faq.md"|resolveFile }}" class="btn btn-link pull-right hidden-xs">
+    F.A.Q
+</a>
+<a href="https://github.com/GitbookIO/gitbook/blob/master/CHANGES.md" target="_blank" class="btn btn-link pull-right hidden-xs">
+    {{ book.version }}
+</a>
+{% endblock %}
+
+{% block page %}
+{{ super() }}
+<hr>
+<div class="btn-group btn-group-justified">
+    {% if page.previous and page.previous.path %}
+    <a class="btn" href="{{ page.previous.path|resolveFile }}"><b>Previous:</b> {{ page.previous.title }}</a>
+    {% endif %}
+    {% if page.next and page.next.path %}
+    <a class="btn" href="{{ page.next.path|resolveFile }}"><b>Next:</b> {{ page.next.title }}</a>
+    {% endif %}
+</div>
+{% endblock %}

api-design/aws/openshift/terraform/Instructions.md renamed to api-tool/aws/openshift/terraform/Instructions.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 legacy.gitbook.com this field is pre-filled. |
+| `description` | Description of your book, default value is extracted from the README. On legacy.gitbook.com this field is pre-filled. |
+| `author` | Name of the author. On legacy.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`) |

api-design/azure/Instructions.md renamed to api-tool/azure/Instructions.md

@@ -0,0 +1,41 @@
+# 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).
+
+##### 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

api-design/readme.md renamed to api-tool/docs/readme.md

@@ -0,0 +1,29 @@
+---
+description: Real world examples of content published using GitBook.
+---
+
+# Examples
+
+More than 50,000 books have been published on [legacy.gitbook.com](https://legacy.gitbook.com/explore).
+
+### Books
+
+- [Front-end Handbook](https://legacy.gitbook.com/book/frontendmasters/front-end-handbook/details) by [Cody Lindley](http://codylindley.com)
+- [How to make an Operating System](https://legacy.gitbook.com/book/samypesse/how-to-create-an-operating-system/details) by [@SamyPesse](https://github.com/SamyPesse)
+- [Building Web Apps with Go](https://legacy.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://legacy.gitbook.com/book/0xax/linux-insides/details) by [0xAX](https://twitter.com/0xAX)
+- [Learn Javascript](https://legacy.gitbook.com/book/gitbookio/javascript/details) by [GitBook](https://twitter.com/GitbookIO)
+
+### Research Papers
+
+- [TowCenter Collection](https://legacy.gitbook.com/@towcenter) by [Columbia Journalism School](http://www.journalism.columbia.edu/)
+- [Block Relaxation Algorithms in Statistics](https://legacy.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/) by [Loomio](https://www.loomio.org/)
+- [Enspiral Handbook](http://handbook.enspiral.com/) by [Enspiral](http://enspiral.com/)
+- This documentation
+

api-tool/readme.md

@@ -0,0 +1,55 @@
+# GitBook FAQ
+
+This page gathers common questions and answers concerning the GitBook format and toolchain.
+
+Questions about the legacy platform at legacy.gitbook.com and the Editor are gather into the [help.legacy.gitbook.com's FAQ](http://help.legacy.gitbook.com/faq.html).
+
+#### How can I host/publish my book?
+
+Books can easily be published and hosted on [legacy.gitbook.com](https://legacy.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://legacy.gitbook.com/editor). [legacy.gitbook.com](https://legacy.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). legacy.gitbook.com and the CLI also looks by default in a serie 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/README.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/SUMMARY.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 ...
+```