diff options
| author | Samy Pessé <samypesse@gmail.com> | 2017-01-06 22:14:38 +0100 |
|---|---|---|
| committer | Samy Pessé <samypesse@gmail.com> | 2017-01-06 22:14:38 +0100 |
| commit | 9440cdee28286c077adec26d5cf2bb679486575e (patch) | |
| tree | a3bc87460b4399aaecf1e7fd6ec197e8901a8a18 /docs/setup.md | |
| parent | cc7b2b2181ce35acdd080edc9adbf8cc6b3f93e4 (diff) | |
| download | gitbook-origin/test-utils.zip gitbook-origin/test-utils.tar.gz gitbook-origin/test-utils.tar.bz2 | |
Improve documentationorigin/test-utils
Diffstat (limited to 'docs/setup.md')
| -rw-r--r-- | docs/setup.md | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/docs/setup.md b/docs/setup.md index 9300678..ce5e0ca 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -2,24 +2,18 @@ Getting GitBook installed and ready-to-go should only take a few minutes. -### GitBook.com +This page describe the process for running the toolchain locally. The easiest for writing and hosting your content is to use [GitBook.com](https://www.gitbook.com) and the [GitBook Editor](https://www.gitbook.com/editor). -[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 +### Requirements Installing GitBook is easy and straightforward. Your system just needs to meet these two requirements: -* NodeJS (v4.0.0 and above is recommended) +* Node.js (v4.0.0 and above is recommended) * Windows, Linux, Unix, or Mac OS X -##### Install with NPM +### Install with NPM -The best way to install GitBook is via **NPM**. At the terminal prompt, simply run the following command to install GitBook: +The best way to install GitBook is via **NPM** (or **Yarn**). At the terminal prompt, simply run the following command to install GitBook: ``` $ npm install gitbook-cli -g @@ -27,7 +21,7 @@ $ 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 +### Create a book GitBook can setup a boilerplate book: @@ -37,6 +31,8 @@ $ gitbook init If you wish to create the book into a new directory, you can do so by running `gitbook init ./directory` +### Preview your website + Preview and serve your book using: ``` @@ -49,7 +45,7 @@ Or build the static website using: $ gitbook build ``` -##### Install pre-releases +### Install pre-releases `gitbook-cli` makes it easy to download and install other versions of GitBook to test with your book: @@ -59,7 +55,7 @@ $ gitbook fetch beta Use `gitbook ls-remote` to list remote versions available for install. -##### Debugging +### Debugging You can use the options `--log=debug` and `--debug` to get better error messages (with stack trace). For example: |