gitbook的使用

安装

1、下载地址:https://nodejs.org/en/

image-20200429165939976

2、下载完成的样子

image-20200429170048801

3、点击安装,右键安装(一路安装)

在cmd窗口,输入node -v

image-20200429170304843

将会看到版本号!

切换npm源的方法 $ npm install -g nrm 安装

输入nrm ls列出安装源地址

*  npm ---- https://registry.npmjs.org

    cnpm --- http://r.cnpmjs.org/

    taobao -http://registry.npm.taobao.org/

    eu ----- http://registry.npmjs.eu/

    au -----  http://registry.npmjs.org.au/

    sl ----- http://npm.strongloop.com/

    nj -----  https://registry.nodejitsu.com/

带*的是当前使用的源,上面的输出表明当前源是官方源。
 $ nrm use taobao
        Registry has beensetto: http://registry.npm.taobao.org/
        使用淘宝安装源

nrm最常用的命令

1.nrm ls 查看已有的源 

2.nrm add <源名称> <源地址> 新增源 

3.nrm use <源名称>切换到现有的源

4.nrm test  测速

4、安装GItBook,命令行输入下述命令

管理员身份运行CMD

npm install gitbook-cli -g
#如果是mac系统linux安装出错可能需要权限执行以下代码
sudo npm install gitbook-cli -g

image-20200429171202802

安装速度有点慢,需要等一会儿!安装示例图:

5、查看是否安装成功,命令行输入下述命令,出现版本号则已安装,否则无

gitbook -V(注意这里的v是大写)

安装此时安装CLI版本,安装完的样子为

image-20200518092634199

GitBook创建以及预览使用

一、gitbook init

1、进入到指定的文件夹执行cmd命令,初始化文件夹,会自动生成两个必要的文件README.md和SUMMARY.md

image-20200429172104769
image-20200429172127067
  • README.md:书的介绍文字,如前言,简介,在章节中也可作为章节的简介
  • SUMMARY.md:定制书籍的章节结构和顺序。

2、在gitbook的使用文件夹下面增加其他章节的文件,文件目录如下:

image-20200429172606577

3、GitBook使用SUMMARY.md文件作为书记的目录结构,可以用来制作书籍目录。

image-20200429173324932

4、预览

a、执行命令git server,gitbook会启动一个4000端口用于预览

image-20200429173302287

b、第二种预览方式,运行gitbook build命令狗会在书籍文件夹中生成一个_book文件夹的内容即为生成的html文件,生成网页不需要开启服务器。

注意:

当执行gitbook serve后保存找不到fontsettings.js

一般的降低版本

其他解决办法:先执行一次gitbook build,在执行gitbook serve就不会报错了!

安装插件

安装插件只需要在书籍目录下增加book.json文件,例如增加折叠目录的插件,需要在book.json内增加下面代码:

{
    "plugins": ["expandable-chapters-small"],
    "pluginsConfig": {
        "expandable-chapters-small":{}
    }
}
//常用插件
{
    "plugins": [
         "back-to-top-button",//回到顶部插件
         "expandable-chapters",//目录扩展,还可以
          "splitter"//安装的时候次软件没有安装成功
        "-lunr", "-search", "search-pro",//这3个支持中文搜索
    ]
}

然后终端执行install来安装插件即可。

gitbook install

至于插件可以再https://www.npmjs.com/search?q=gitbook进行搜索安装

常见问题

1、gitbook渲染的时候出现错误 template。比如在渲染django模板的时候 出现问题?

解决办法:在代码的最前面和最后面添加代码区域

2、如何将文档上传到coding?

解决办法:

3、gitbook新版本"gitbook build"命令导出的html本地不能跳转的问题解决

解决办法:在导出的文件夹目录下找到gitbook->theme.js文件

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

推荐阅读更多精彩内容