GitBook 基本操作

写在前面

本文主要的目的是介绍如何快速的在本地快速启动一个 GitBook 项目并使用浏览器进行阅读。内容比较简单,仅用作备忘,以便后面查阅。

软件安装

gitbook 命令行工具基于 Node.js 平台,并且只兼容 10.x 版本,所以读者需要访问 https://nodejs.org/dist/latest-v10.x/ 下载对应平台的 Node.js 安装文件进行安装。之后运行以下命令安装 gitbook-cli:

注意: Windows 用户请打开 PowerShell 执行安装命令。

# 确认 Node.js 版本
$ node -v
v10.22.0

# 安装 gitbook-cli
$ npm install -g gitbook-cli

# 确认 gitbook-cli 版本
$ gitbook ls
GitBook Versions Installed:

    * 3.2.3

Run "gitbook update" to update to the latest version.

启动 GitBook 项目

请访问 https://www.npmjs.com/package/gitbook 详细了解如何构建一个符合 GitBook 的项目。进入 gitbook 项目主目录,执行 gitbook serve 在本地启动服务:

$ 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 82 pages
info: found 236 asset files
info: >> generation finished with success in 14.0s !

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

最后根据提示访问 http://localhost:4000/ 在浏览器查看文档。

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

推荐阅读更多精彩内容

  • 想搭建一个 gitbook,可以导出到本地,用浏览器打开 index.html就可以打开整本书,然后可以点击左边的...
    Lovell_阅读 1,426评论 1 3
  • 前端工程化 前端工程化就是通过各种工具和技术,提升前端开发效率的过程 Node.js Node.js是除了浏览器之...
    安掌门dear阅读 572评论 0 1
  • # 前言 最近想找一个记笔记的软件,试了几款都觉得差点意思,后来看到别人用gitbook写的笔记就想试试,接触以后...
    Broken故城阅读 172,779评论 15 95
  • NPM官方文档写的十分良心,此篇我做一些比较常用功能的积累,有些地方是翻译,有些地方省略可以去官文看。 NPM是什...
    宋乐怡阅读 2,415评论 0 2
  • Gitbook的安装 node.js的安装 gitbook是一个基于Node.js的命令行工具,所以要先安装Nod...
    0e1114d6726b阅读 3,772评论 0 0