Skip to content

Commit 31d8ca7

Browse files
author
starlying
committed
document
1 parent 906de04 commit 31d8ca7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1577
-34
lines changed

‎.gitignore

+27-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
_book
1+
# Logs
2+
logs
3+
*.log
4+
5+
# Runtime data
6+
pids
7+
*.pid
8+
*.seed
9+
10+
# Directory for instrumented libs generated by jscoverage/JSCover
11+
lib-cov
12+
13+
# Coverage directory used by tools like istanbul
14+
coverage
15+
16+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
17+
.grunt
18+
19+
# Compiled binary addons (http://nodejs.org/api/addons.html)
20+
build/Release
21+
22+
# Dependency directory
23+
# Deployed apps should consider commenting this line out:
24+
# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
25+
node_modules
26+
27+
_book/

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+16-23
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,30 @@
1-
gitbook
2-
======
1+
GitBook Documentation
2+
=============
33

4-
This is a simple template shows how to quickly start a [GitBook](https://www.gitbook.io)
4+
This book contains the entire documentation for **GitBook** (gitbook.com and format).
55

6-
这是个快速开始 [GitBook](https://www.gitbook.io) 的模板项目
6+
### Open Source Format
77

8-
##Usage 用法
8+
The toolchain (GitBook) is a tool for building beautiful books using Git and Markdown. It can generate your book in many formats: **PDF**, **ePub**, **mobi** or as a **website**.
99

10-
###Installation 安装
10+
It is open source, the source code of the tool is available on [GitHub](https://github.com/GitbookIO/gitbook).
1111

12-
$ npm install gitbook -g
13-
14-
###Checkout the repository 检出项目
12+
Issues and question related to the format and the toolchain should be posted on [GitHub](https://github.com/GitbookIO/gitbook/issues)
1513

16-
$ git clone https://github.com/waylau/gitbook.git
17-
18-
###Build 编译
14+
### GitBook.com
1915

20-
$ gitbook build ./
21-
22-
This is a `_book` directory was created.
16+
GitBook.com is the online platform ([www.gitbook.com](https://www.gitbook.com)) to create and host books built using the GitBook format.
2317

24-
![](http://99btgc01.info/uploads/2014/12/02%282%29.jpg)
18+
### Other documentations
2519

26-
###Run 运行
20+
Documentation for developers (API & Plugins) is accessible at [developer.gitbook.com](https://developer.gitbook.com).
2721

28-
run the `index.html` in the `_book` directory .
29-
30-
打开该目录，右键运行 index.html 即可看到 gitbook 的效果
22+
Setup guide and documentation for the enterprise version is accessible at [help.enterprise.gitbook.com](http://help.enterprise.gitbook.com).
3123

32-
![](http://99btgc01.info/uploads/2014/12/03%282%29.jpg)
24+
### Help and Support
3325

34-
![](http://99btgc01.info/uploads/2014/12/04%282%29.jpg)
26+
We're always happy to help out with your books or any other questions you might have. You can ask a question or signal an issue on the following contact form at [gitbook.com/contact](https://www.gitbook.com/contact).
3527

36-
Welcome to vist my blog at [www.waylau.com](http://www.waylau.com/)
28+
### Contribute to this documentation
3729

30+
You can contribute to improve this documentation on [GitHub](https://github.com/GitbookIO/documentation) by signaling issues or proposing changes.

‎SUMMARY.md

+37-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,40 @@
11
# Summary
22

3-
This is the summary of my book.
3+
* [Introduction](README.md)
4+
* [Format](format/README.md)
5+
* [Output](format/output.md)
6+
* [Readme and Introduction](format/introduction.md)
7+
* [Chapters and Subchapters](format/chapters.md)
8+
* [Markdown](format/markdown.md)
9+
* [AsciiDoc](format/asciidoc.md)
10+
* [Cover](format/cover.md)
11+
* [Multi-Languages](format/languages.md)
12+
* [Glossary](format/glossary.md)
13+
* [Templating](format/templating.md)
14+
* [Content References](format/conrefs.md)
15+
* [Ignoring files & folders](format/ignore.md)
16+
* [Configuration](format/configuration.md)
17+
* [Plugins](format/plugins.md)
18+
* [Styling](styling/book.md)
19+
* [Math & TeX](format/math.md)
20+
* [Build](build/README.md)
21+
* [Update with GIT](build/push.md)
22+
* [Common Errors](build/errors.md)
23+
* [ebook-convert](build/ebookconvert.md)
24+
* [GitHub Integration](github/README.md)
25+
* [Transferring content to GitHub](github/transferring_to_github.md)
26+
* [Editor](editor/README.md)
27+
* [Draft Workflow](editor/draft.md)
28+
* [Chapters](editor/chapters.md)
29+
* [Search](platform/search.md)
30+
* [Taxes](platform/taxes.md)
31+
* [Visibility](platform/visibility.md)
32+
* [Custom Domains](platform/domains.md)
33+
* [Account](account/README.md)
34+
* [Duplicate](account/duplicate.md)
35+
* [Organizations](platform/organizations/README.md)
36+
* [Differences with users](platform/organizations/differences.md)
37+
* [Convert an user](platform/organizations/convert.md)
38+
* [Transferring ownership](platform/organizations/ownership.md)
39+
* [Webhooks](platform/hooks.md)
440

5-
* section 1
6-
* [example 1](section1/example1.md)
7-
* [example 2](section1/example2.md)
8-
* [section 2](section2/README.md)
9-
* [example 1](section2/example1.md)

‎account/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Account
2+
3+
Each user/author on GitBook is associated with an account. You can create an account using your email or a Social Account such as **Facebook**, **Twitter**, **Google** or **GitHub**.
4+
5+
### Delete your account
6+
7+
You can delete your personal account at [www.gitbook.com/settings](https://www.gitbook.com/settings).
8+
9+
This action **CANNOT** be undone. This will delete all your books, builds, and transactions permanently. Once you delete your account, there is no going back. Please be certain.

‎account/duplicate.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Duplicate Account
2+
3+
It occurs that you registered with a Social Account (Facebook, Twitter, GitHub or Google), then registered again using the form.
4+
5+
In this case, you created two distinct accounts (one associated with your email, and another with your Social Account).
6+
7+
You need to **remove** one of these account, to do so:
8+
9+
1. Logout from the account associated with your email
10+
2. Login back using the social account
11+
3. Delete this account at [www.gitbook.com/settings](https://www.gitbook.com/settings)
12+
4. Login back using your email
13+
5. Associate the Social Account to your email account at [www.gitbook.com/settings](https://www.gitbook.com/settings)
14+

‎assets/activity.png

67 KB
Loading

‎assets/add_domain.png

128 KB
Loading

‎assets/build.png

36.9 KB
Loading

‎assets/editor.png

233 KB
Loading

‎assets/login.png

29.6 KB
Loading

‎assets/mailing_stats.png

13.7 KB
Loading

‎assets/publish.png

34.2 KB
Loading

‎assets/webhooks.png

62 KB
Loading

‎book.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"gitbook": "2.x.x",
3+
"plugins": [],
4+
"links": {
5+
"sidebar": {
6+
"Contact us / Support": "https://www.gitbook.com/contact"
7+
}
8+
},
9+
"pluginsConfig": {}
10+
}

‎build/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Builds and History
2+
3+
After you pushed content using [**git** or the **editor**](./push.md), GitBook.com will start different builds:
4+
5+
- **website**: it will generate the website
6+
- **json**: it will extract metadata about the book (summary, introduction, etc)
7+
- **epub**: it will generate the epub download
8+
- **pdf**: it will generate the pdf download
9+
10+
These builds are listed and detailed on the **History** tab of your book.
11+
12+
### Builds not triggered
13+
14+
If your book is linked to GitHub, it may happen that GitHub doesn't signal changes to GitBook (for example: if authorizations are reset).
15+
Information on how to fix this issue is available on the [GitHub integration section](../github/README.md).
16+
17+
### Fixing build errors
18+
19+
If your build failed, you can use the logs to debug the issue and publish a fixed content.
20+
21+
[Read more about common build errors](./errors.md)

0 commit comments

Comments
 (0)