diff options
author | Samy Pessé <samypesse@gmail.com> | 2016-02-21 11:01:49 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2016-02-21 11:01:49 +0100 |
commit | 40f829ce54d6fe8c56c1005ed7229d198918acb9 (patch) | |
tree | 534b2ac9fd35afd8fe3251d4104aac26aa12ed13 /docs | |
parent | e16b3e35f438014cb51fac84a500c8996d18658d (diff) | |
download | gitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.zip gitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.tar.gz gitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.tar.bz2 |
Add docs for setup gitbook
Diffstat (limited to 'docs')
-rw-r--r-- | docs/SUMMARY.md | 7 | ||||
-rw-r--r-- | docs/faq.md | 3 | ||||
-rw-r--r-- | docs/setup.md | 37 | ||||
-rw-r--r-- | docs/structure.md | 26 |
4 files changed, 69 insertions, 4 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index a4f2a98..247fc27 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -4,14 +4,15 @@ * [About this document](README.md) * [Installation and Setup](setup.md) -* [Directory structure](structure.md) ### Your Content -* [Configuration](config.md) +* [Directory structure](structure.md) * [Pages and Summary](pages.md) -* [Assets](assets.md) +* [Assets and Images](assets.md) * [Glossary](glossary.md) +* [Multi-Lingual](langs.md) +* [Configuration](config.md) ### Miscellaneous diff --git a/docs/faq.md b/docs/faq.md index 592fbdc..f960409 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -4,5 +4,6 @@ You should always use `.md` extensions for your relative links, GitBook will automatically replace these links by the right value 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. GitBook.com and the CLI also looks by default in a series of [folders](structure.md).
\ No newline at end of file diff --git a/docs/setup.md b/docs/setup.md new file mode 100644 index 0000000..aaa0407 --- /dev/null +++ b/docs/setup.md @@ -0,0 +1,37 @@ +# 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's best and easier solution for publishing your content and collaborate on it. + +It integrates well with the [GitBook Editor](https://www.gitbook.com/editor). + +### Local Installation + +##### Requirements + +Installing GitBook is easy and straight-forward, but there are a few requirements you’ll need to make sure your system has before you start. + +* NodeJS (v4.0.0 and above are adviced) +* 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 to build a book. + +##### Using pre-releases + +`gitbook-cli` makes it easy to install and test other versions of GitBook with your book: + +``` +$ gitbook install beta +``` + diff --git a/docs/structure.md b/docs/structure.md new file mode 100644 index 0000000..f6ae617 --- /dev/null +++ b/docs/structure.md @@ -0,0 +1,26 @@ +# Directory structure + + +``` +. +├── 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 | + + +### Sub-directory |