GitBook快速入门!

1.软件准备

因为我现在是这方面的小白,因此这篇文章是给小白看的,也是怎么最方便怎么来。
本文主要是应对windows上面进行安装使用的。
需要准备如下的两个基本软件:

  • GitBook Editor
  • Node.js

1.1 GitBook Editor的安装

GitBook的官网是:https://www.gitbook.com/
对于GitBook的编辑器的下载所在的网页是:https://www.gitbook.com/editor/
展示的是如下类似的网页,未来可能变化的不同:

1.png

在图片的上方可以看到对于不同操作系统的选择,可以根据这个选择不同的操作系统。
我的电脑是windows系统的,右面显示的windows的下载按钮,直接点击就可以下载。
有时候,可能因为某些原因,下载过慢,我将在我的阿里云空间里面放一个备份,如果官网上的下载失败,可以试着从我在网上放置的这个文件下载。(当然,可以后期续费等原因,这个连接可能失效,失效勿喷啊)
我的阿里云下载链接:
点此下载

对于这个软件的安装,没有什么可说的,就是那个样子。

1.2 Node.js的安装

对于Nodejs的官网是:https://nodejs.org/en/
需要安装这个是由于Gitbook和里面的一些工具的使用和安装与这种语言有关。
打开Nodejs的官网显示如下:

2.png

在中间有两个大的按钮,这两个都是可以使用的软件下载按钮。左边的按钮是一个长期维护版,右边的是一个当前最新版。两个都可以使用。
同样,我也计划在我的阿里云空间里面放置一个可用的软件备份,放置直接在官网上下载速度过慢。
下载地址如下:
点击下载
安装过程非常简单,不再更多描述。
在安装的时候,要确认npm要安装上,并且添加到系统变量,否者下面的安装不方便进行;在默认的情况下,这个是选中的,因此默认就好。

分别使用下面的命令来确认是否安装nodejs和npm,并将其配置到环境变量里面:

1. node -v
2. npm -v

如果安装成功的话,会分别显示他们的版本号,这样就安装成功了。

1.3 用到的其他命令行工具安装

使用命令行安装能够生成html静态网页的工具。
这个软件的安装就会用到前面安装的nodejs和npm。
这个是要通过管理员权限启动cmd来进行安装的,我的使用普通用户的权限是安装不成功的,因此建议使用管理员权限启动cmd来进行安装。
使用如下的命令进行安装:

npm install gitbook-cli -g

在安装完成后,会显示类似于如下的基本信息:

C:\Users\***\AppData\Roaming\npm\gitbook -> C:\Users\***\AppData\Roaming\npm\node_modules\gitbook-cli\bin\gitbook.js
+ gitbook-cli@***
updated 1 package in **.***s

然后通过命令行进行测试,测试的代码如下:

gitbook -V

注意:上面的”V”是大写字母,如果是小写的话,没有任何显示。
如果安装正确的话,会显示如下的输出:

1. CLI version: *.*.*
2. GitBook version: *.*.*

上面的“*”表示具体的数字,根据安装的版本不同而不同。

2.软件的使用

2.1.1 使用gitbook对文档进行初始化

进入要放置编辑文档的目录,在下面使用如下命令:

gitbook init

可以查看到,生成了相应的两个文档,一个是概述文档,一个readme文档。
如果有些大牛的话,可以使用了,但是我本身比较笨,这种方法觉得不好用,但是很多人会觉得这样写控制力更强,或许是,但是我不太推荐这样的方式

2.2 使用GitBook Editor初始化写文档

打开刚才安装的GitBook软件,如下界面(不想登录的可以点击右下角直接跳过):


不想登录的可以点击右下角直接跳过.png

点击进去:


新建文档.png

2.2.1 增加新的文档

单击软件界面图中的“+ New Book”按键,然后弹出如下的对话框:
填入文档名.png

在对话框里面输入要创建书(文档)的名称,点击变成“Confirm”按钮,这样就会创建一本新书。
将会打开下面的软件界面,在上面就可以编辑文档了。


20180108162117458.png

在软件的左边框选出的部分可以创建新的章节和文档,也可以在章节题目上右键创建子文档;在右边是文档的编辑窗口。
现在问题来了:刚才生成的新书在哪里呢?

经过查找,我的电脑是win10,生成的书,在如下的位置:

C:\Users\***\GitBook\Library\Import

在下面能够找到相应的文件夹,将其copy出来,放在想要放的位置,然后再使用GitBook Editor打开编辑即可

2.3 生成静态网页

通过如下的命令,将上面的2.1和2.2生成的文档都可以生成静态网页。
进入相应的根文件夹,在里面运行如下的命令:

gitbook serve

在界面上显示如下代码:

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.5s !

Starting server ...
Serving book on http://localhost:4000

对于上面的结果,很明显可以看出,在网页里面使用:

http://localhost:4000

可以访问在网页上面展示这些内容。
在根目录下,同样生成了一个文件夹”_book”,这个文件夹就是生成的静态文档,在文件夹里面找到”index.html”就能进行相同的访问。
转自:https://blog.csdn.net/cn_newer/article/details/79002911
其他博客参考:
1、https://www.crifan.com/gitbook_gitbook_editor_usage_summary_note/
2、https://www.crifan.com/category/work_and_job/document_generation/
3、https://www.jianshu.com/p/f9f9ca86ef22
4、https://www.jianshu.com/p/427b8bb066e6
5、http://gitbook.zhangjikai.com/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容