Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ac900aa

Browse files
committed
Merge pull request GitbookIO#263 from jpoesen/patch-1
Minor typo, grammar and style corrections.
2 parents 38cbbe4 + 422cbed commit ac900aa

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ GitBook
33

44
[![Build Status](https://travis-ci.org/GitbookIO/gitbook.png?branch=master)](https://travis-ci.org/GitbookIO/gitbook)
55

6-
GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. A complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
6+
GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. Complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
77

88
![Image](https://raw.github.com/GitbookIO/gitbook/master/preview.png)
99

@@ -35,23 +35,23 @@ Options for commands `build` and `serve` are:
3535
--config <config file> Configuration file to use, defaults to book.json
3636
```
3737

38-
GitBook load the default configuration from a `book.json` file in the repository if it exists.
38+
GitBook loads the default configuration from a `book.json` file in the repository if it exists.
3939

4040
Here are the options that can be stored in this file:
4141

4242
```
4343
{
44-
// Folders to use for output (caution: it override the value from the command line)
44+
// Folders to use for output (caution: it overrides the value from the command line)
4545
"output": null,
4646
47-
// Generator to use for building (caution: it override the value from the command line)
47+
// Generator to use for building (caution: it overrides the value from the command line)
4848
"generator": "site",
4949
5050
// Book title and description (defaults are extracted from the README)
5151
"title": null,
5252
"description": null,
5353
54-
// GitHub informations (defaults are extracted using git)
54+
// GitHub information (defaults are extracted using git)
5555
"github": null,
5656
"githubHost": "https://github.com/",
5757
@@ -67,9 +67,9 @@ Here are the options that can be stored in this file:
6767
}
6868
},
6969
70-
// set another theme with your own layout
71-
// it's recommended to use plugins or add more options for default theme, though
72-
// see https://github.com/GitbookIO/gitbook/issues/209
70+
// Set another theme with your own layout
71+
// It's recommended to use plugins or add more options for default theme, though
72+
// See https://github.com/GitbookIO/gitbook/issues/209
7373
"theme": "./localtheme",
7474
7575
// Links in template (null: default, false: remove, string: new value)
@@ -98,11 +98,11 @@ You can publish your books to our index by visiting [GitBook.io](http://www.gitb
9898

9999
GitBook can generate your book in the following formats:
100100

101-
* **Static Website**: This is the default format, it generates a complete interactive static website that can be for example hosted on GitHub Pages.
102-
* **PDF**: A complete PDF book with exercise solutions at the end of the book. Generate to this format using: ```gitbook pdf ./myrepo```, you need to have [gitbook-pdf](https://github.com/GitbookIO/gitbook-pdf) installed.
103-
* **eBook**: A complete eBook with exercise solutions at the end of the book. Generate to this format using: ```gitbook ebook ./myrepo```, you need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed.
104-
* **Single Page**: The book will be stored in a single printable HTML page, this format is used for conversion to PDF or eBook. Generate to this format using: ```gitbook build ./myrepo -f page```.
105-
* **JSON**: This format is used for debugging or extracting metadata from a book. Generate to this format using: ```gitbook build ./myrepo -f json```.
101+
* **Static Website**: This is the default format. It generates a complete interactive static website that can be, for example, hosted on GitHub Pages.
102+
* **PDF**: A complete PDF book with exercise solutions at the end of the book. Generate this format using: ```gitbook pdf ./myrepo```. You need to have [gitbook-pdf](https://github.com/GitbookIO/gitbook-pdf) installed.
103+
* **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.
104+
* **Single Page**: The book will be stored in a single printable HTML page. This format is used for conversion to PDF or eBook. Generate this format using: ```gitbook build ./myrepo -f page```.
105+
* **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo -f json```.
106106

107107
## Book Format
108108

@@ -134,7 +134,7 @@ Files that are not included in `SUMMARY.md` will not be processed by `gitbook`.
134134

135135
#### Exercises
136136

137-
A book can contain interactive exercises (currently only in Javascript but Python and Ruby are coming soon ;) ). An exercise is a code challenge provided to the reader, which is given a code editor to write a solution which is checked against the book author's validation code.
137+
A book can contain interactive exercises (currently only in Javascript but Python and Ruby are coming soon ;) ). An exercise is a code challenge provided to the reader, who is given a code editor to write a solution which is checked against the book author's validation code.
138138

139139
An exercise is defined by 4 simple parts:
140140

@@ -143,7 +143,7 @@ An exercise is defined by 4 simple parts:
143143
* **Solution** code, being a correct solution to the exercise
144144
* **Validation** code that tests the correctness of the user's input
145145

146-
Exercises need to start and finish with a separation bar (```---``` or ```***```). It should contain 3 code elements (**base**, **solution** and **validation**). It can contain a 4th element that provides **context** code (functions, imports of libraries etc ... that shouldn't be displayed to the user).
146+
Exercises need to start and finish with a separation bar (```---``` or ```***```). It should contain 3 code elements (**base**, **solution** and **validation**). It can contain a 4th element that provides **context** code (functions, imports of libraries, etc which shouldn't be displayed to the user).
147147

148148
---
149149

@@ -185,7 +185,7 @@ You can see a complete example with the [Learn Git](https://github.com/GitbookIO
185185

186186
#### Ignoring files & folders
187187

188-
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`)
188+
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`)
189189

190190
#### Cover
191191

@@ -196,11 +196,11 @@ A small version of the cover can also be set by creating a file: **/cover_small.
196196

197197
#### Publish your book
198198

199-
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**.
199+
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**.
200200

201201
#### Plugins
202202

203-
Plugins can 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.
203+
Plugins can 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.
204204

205205
##### Default plugins:
206206

0 commit comments

Comments
 (0)