Skip to content

Commit 6d79c73

Browse files
committed
update to gitbook v3.2.2
1 parent e5c274e commit 6d79c73

20 files changed

+680
-242
lines changed

GLOSSARY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Git
2+
分散式版本控制软件
3+
4+
## Markdown
5+
Aaron Swartz 跟John Gruber共同设计的排版语言

SUMMARY.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Summary
2-
3-
* [前言](README.md)
2+
## 基本使用
3+
* [前言](introduction.md)
44
* [安装](installation.md)
55
* [命令](commands.md)
6+
* [目录结构](structure.md)
67
* [配置](settings.md)
8+
9+
## 扩展
710
* [插件](plugins.md)
11+
* [主题](themes.md)
812
* [bookjson](bookjson.md)
9-

api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

api.tag

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{% sample lang="js" %}
2+
这里演示 JavaScript 如何输出信息到控制台
3+
4+
```js
5+
console.log('Hello World');
6+
```
7+
8+
{% sample lang="java" %}
9+
这里演示 Java 如何输出信息到控制台
10+
11+
```java
12+
System.out.println("Hello World");
13+
```
14+
15+
{% common %}
16+
这里是 JavaScript 和 Java 共同的信息
17+
18+
{% endmethod %}

assets/images/api.png

51.5 KB
Loading

assets/images/comscore.png

61.5 KB
Loading

assets/images/faq.png

110 KB
Loading

assets/images/summary1.png

12.1 KB
Loading

assets/images/summary2.png

13.8 KB
Loading

book.json

Lines changed: 104 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,134 @@
11
{
2-
"title" : "Gibook Use",
3-
"description" : "记录Gitbook的配置和一些插件的使用",
4-
"author" : "zhangjikai",
5-
"generator": "site",
6-
"language" : "zh-hans",
7-
"gitbook" : "2.6.4",
8-
"links" : {
9-
"sidebar" : {
10-
"Home" : "https://zhangjikai.com"
2+
"title": "Gibook Use",
3+
"description": "记录Gitbook的配置和一些插件的使用",
4+
"author": "zhangjikai",
5+
"output.name": "site",
6+
"language": "zh-hans",
7+
"gitbook": "3.2.2",
8+
"root": ".",
9+
"structure" : {
10+
"readme": "introduction.md"
11+
},
12+
"links": {
13+
"sidebar": {
14+
"Home": "http://www.zhangjikai.com"
1115
}
1216
},
13-
"plugins": [
14-
"disqus",
17+
"plugins": [
18+
"-lunr",
1519
"-search",
16-
17-
18-
"github",
19-
"ace",
20-
"emphasize",
21-
"katex",
22-
"anchors",
23-
"include-codeblock",
24-
"mermaid",
25-
"tbfed-pagefooter",
26-
"sectionx",
27-
"expandable-chapters",
28-
"codeblock-filename",
29-
"baidu",
30-
31-
"donate",
32-
"local-video",
33-
"toc",
34-
"edit-link",
35-
36-
20+
"-highlight",
21+
"search-plus@^0.0.11",
22+
"simple-page-toc@^0.1.1",
23+
"github@^2.0.0",
24+
25+
"edit-link@^2.0.2",
26+
"disqus@^0.1.0",
27+
"prism@^2.1.0",
28+
"prism-themes@^0.0.2",
29+
"advanced-emoji@^0.2.1",
30+
"anchors@^0.7.1",
31+
"include-codeblock@^3.0.2",
32+
"ace@^0.3.2",
33+
"emphasize@^1.1.0",
34+
"katex@^1.1.3",
35+
"splitter@^0.0.8",
36+
"mermaid@^0.0.9",
37+
"tbfed-pagefooter@^0.0.1",
38+
"expandable-chapters-small@^0.1.7",
39+
"sectionx@^3.1.0",
40+
"baidu@^0.1.0",
41+
"donate@^1.0.2",
42+
"local-video@^1.0.1",
43+
"sitemap-general@^0.1.1",
44+
45+
"favicon@^0.0.2",
46+
"todo@^0.1.3"
3747
],
3848
"pluginsConfig": {
49+
"theme-default": {
50+
"showLevel": true
51+
},
3952
"disqus": {
4053
"shortName": "gitbookuse"
4154
},
55+
"prism": {
56+
"css": [
57+
"prism-themes/themes/prism-base16-ateliersulphurpool.light.css"
58+
]
59+
},
4260
"github": {
4361
"url": "https://github.com/zhangjikai/gitbook-use"
4462
},
45-
"search-pro": {
46-
"cutWordLib": "nodejieba",
47-
"defineWord": ["gitbook-use"]
48-
},
49-
63+
"github-buttons": {
64+
"repo": "zhangjikai/gitbook-use",
65+
"types": [
66+
"star"
67+
],
68+
"size": "small"
69+
},
70+
"include-codeblock": {
71+
"template": "ace",
72+
"unindent": true,
73+
"edit": true
74+
75+
},
5076
"sharing": {
5177
"weibo": true,
5278
"facebook": true,
5379
"twitter": true,
5480
"google": false,
5581
"instapaper": false,
56-
"vk": false,
82+
"vk": false,
5783
"all": [
58-
"facebook", "google", "twitter",
59-
"weibo", "instapaper"
84+
"facebook",
85+
"google",
86+
"twitter",
87+
"weibo",
88+
"instapaper"
6089
]
6190
},
62-
6391
"tbfed-pagefooter": {
64-
"copyright":"Copyright &copy zhangjikai.com 2017",
92+
"copyright": "Copyright © zhangjikai.com 2017",
6593
"modify_label": "该文件修订时间:",
6694
"modify_format": "YYYY-MM-DD HH:mm:ss"
6795
},
68-
6996
"baidu": {
70-
"token" : "ff100361cdce95dd4c8fb96b4009f7bc"
97+
"token": "ff100361cdce95dd4c8fb96b4009f7bc"
7198
},
72-
"sitemap": {
73-
"hostname": "https://gitbook.zhangjikai.com"
74-
},
75-
7699
"donate": {
77-
"wechat": "https://zhangjikai.com/resource/weixin.png",
78-
"alipay": "https://zhangjikai.com/resource/alipay.png",
79-
"title": "",
80-
"button": "",
81-
"alipayText": "支付宝打赏",
82-
"wechatText": "微信打赏"
100+
"wechat": "https://zhangjikai.com/resource/weixin.png",
101+
"alipay": "https://zhangjikai.com/resource/alipay.png",
102+
"title": "",
103+
"button": "",
104+
"alipayText": "支付宝打赏",
105+
"wechatText": "微信打赏"
106+
},
107+
"simple-page-toc": {
108+
"maxDepth": 3,
109+
"skipFirstH1": true
110+
},
111+
"edit-link": {
112+
"base": "https://github.com/zhangjikai/gitbook-use/edit/master",
113+
"label": "Edit This Page"
83114
},
84-
85-
"edit-link": {
86-
"base": "https://github.com/zhangjikai/gitbook-use/edit/master",
87-
"label": "Edit This Page"
88-
}
89-
115+
"sitemap-general": {
116+
"prefix": "http://gitbook.zhangjikai.com"
117+
},
118+
119+
"anchor-navigation-ex": {
120+
"isRewritePageTitle": false,
121+
"tocLevel1Icon":"fa fa-hand-o-right",
122+
"tocLevel2Icon":"fa fa-hand-o-right",
123+
"tocLevel3Icon":"fa fa-hand-o-right"
124+
},
125+
"sectionx": {
126+
"tag": "b"
127+
},
128+
"favicon":{
129+
"shortcut": "favicon.ico",
130+
"bookmark": "favicon.ico"
131+
}
132+
90133
}
91-
}
134+
}

bookjson.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## book.json配置文件
1+
# book.json配置文件
22

33
<!--email_off-->
44
[import](book.json)
5-
<!--/email_off-->
5+
<!--/email_off-->

commands.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
## 命令
1+
# 命令
2+
23
这里主要介绍一下 GitBook 的命令行工具 `gitbook-cli` 的一些命令, 首先说明两点:
34
* `gitbook-cli``gitbook` 是两个软件
45
* `gitbook-cli` 会将下载的 gitbook 的不同版本放到 `~/.gitbook`中, 可以通过设置`GITBOOK_DIR`环境变量来指定另外的文件夹

favicon.ico

4.19 KB
Binary file not shown.

installation.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1-
## GitBook安装
1+
# GitBook安装
2+
下面介绍在本地如何安装 GitBook,如果不需要本地调试 & 不需要获得生成的 html 文件,可以直接使用 [官网](https://www.gitbook.com/) 提供的服务。
3+
<!-- toc -->
24

3-
### 环境要求
5+
## 环境要求
46

57
* NodeJS(v4.0.0及以上)
68

7-
### 通过NPM安装
9+
## 通过NPM安装
810
运行下面的命令进行安装
911
```bash
1012
npm install gitbook-cli -g
1113
```
1214
其中`gitbook-cli`是gitbook的一个命令行工具, 通过它可以在电脑上安装和管理gitbook的多个版本.
1315

14-
### 编辑书籍
15-
gitbook 官方已经提供了一个本地的[编辑器](https://www.gitbook.com/editor/osx), 使用它可以方便的编写书籍(不需要手动的写SUMMARY.md), 并且支持windows、mac、linux 三种平台, 所以强烈建议使用编辑器编写书籍.
16+
## 编辑书籍
17+
gitbook 官方已经提供了一个本地的[编辑器](https://www.gitbook.com/editor/osx), 使用它可以方便的编写书籍(不需要手动的写SUMMARY.md), 并且支持windows、mac、linux 三种平台, 所以强烈建议使用编辑器编写书籍.
1618

17-
### 预览书籍
19+
## 预览书籍
1820
使用下列命令会运行一个服务器, 通过`http://localhost:4000/`可以预览书籍
1921
```bash
2022
gitbook serve

introduction.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# 前言
2+
主要记录GitBook的安装配置以及一些插件信息, 下面是GitBook的一些资源
3+
4+
* [GitBook主页](https://www.gitbook.com/)
5+
* [Github地址](https://github.com/GitbookIO/)
6+
* [GitBook编辑器](https://www.gitbook.com/editor/osx)
7+
* [GitBook Toolchain Documentation](http://toolchain.gitbook.com/)
8+
* [GitBook Documentation](http://help.gitbook.com/)
9+
10+
---
11+
> 如若转载请标明出处.

0 commit comments

Comments
 (0)