GiBbook实用配置以及插件使用

GitBook可以在您的计算机上用于构建本地书籍,,可以本地预览

安装gitbook

环境要求:
安装GitBook,您的系统需要安装NodeJS(推荐v4.0.0及以上版本)
下载地址

使用npm安装

安装GitBook的最佳方法是通过NPM。在终端提示符(cmd命令行)下,只需执行以下命令即可安装GitBook:

npm install gitbook-cli -g

gitbook-cli是一个在同一系统上安装和使用多个版本的GitBook的实用程序。它将自动安装所需版本的GitBook来构建一本书。
安装成功后,执行gitbook -V查看版本信息。
至此,gitbook安装成功

GitBook 基本使用

gitbook 的基本用法非常简单,基本上就只有两步:

  1. 执行gitbook init初始化书籍目录
  2. 执行gitbook serve编译书籍

下面将结合一个非常简单的实例,来介绍 gitbook 的基本用法。

初始化 - gitbook init

  1. 首先,编辑文件内容
  2. 在书籍项目根目录执行 gitbook init命令初始化文件夹,会自动生成两个必要的文件 README.md 和 SUMMARY.md(这两个文件是GitBook制作电子书的必要文件)。
  • README.md: 书的介绍文字,如前言、简介,在章节中也可做为章节的简介。
  • SUMMARY.md: 定制书籍的章节结构和顺序。
  1. 我的文件目录树
    执行tree \f命令可以查看文件目录(包含文件夹和文件)
├─GitBook.md
├─README.md
├─SUMMARY.md
├─chapter1
│     ├─file1.md
│     └─file2.md
└─chapter2
      └─other.md
  1. 编辑目录文件——SUMMARY.md
    目录的语法如下:* [显示的目录名](文件夹/文件名#标题id)
    这里的id有个规则,基本上是和标题名一致:
    • -/中文字体/数字/小写字母格式不变
    • 大写字母改成小写
    • 大部分特殊符号直接省略不写
    • 空格用符号-代替
# Summary 示例目录
* [Introduction](README.md)
* [GitBook](GitBook.md)
    * [安装GitBook](GitBook.md)
    * [操作环境](GitBook.md#操作环境)
        * [NodeJs安装](GitBook.md#nodejs安装)
    * [初始化](GitBook.md#初始化)
    * [预览](GitBook.md#预览)
* [文件一](chapter1/file1.md)
    * [个性化配置](chapter1/file1.md#个性化setting)
    * [插件](chapter1/file1.md#插件)
* [文件二](chapter1/file2.md)
* [其他](chapter2/other.md)

预览书籍 - gitbook serve

书籍目录结构创建完成以后,就可以执行gitbook serve命令来编译和预览书籍了。

  1. 编译:命令行中执行gitbook serve
    gitbook serve 命令实际上会首先调用 gitbook build 编译书籍,完成以后会打开一个 web 服务器,监听在本地的 4000 端口。
  2. 预览:浏览器访问 http://localhost:4000 如图:

个性化使用 - GitBook插件

  1. 在书籍目录下新增book.json文件,然后增加插件代码。
    例如增加设置logo插件,在book.json中添加以下代码:
{
    "plugins": [ "insert-logo" ]
    "pluginsConfig": {
      "insert-logo": {
        "url": "images/logo.png",
        "style": "background: none; max-height: 30px; min-height: 30px"
      }
    }
}

我写了一篇关于GitBook插件使用的文章。
附700个插件:官方地址

  1. 保存book.json,执行gitbook install安装,或者执行npm install gitbook-plugin-insert-logo
    如果报错说明json文件可能有语法问题
    两种安装方式介绍:
    • 使用gitbook-cli 方式,即gitbook install,把book.json中所有的插件列表都安装一遍,如果修改了插件的配置文件,会被覆盖
    • 使用NPM安装,只是单独安装一个插件,不影响其他插件
  2. 执行gitbook serve预览
  3. 其他插件:
    官方获取插件地址:https://plugins.gitbook.com
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349

推荐阅读更多精彩内容

  • 最近遇到一些问题,就是团队中会有些伙伴踩得坑的收集问题或者有些较为复杂的业务需求文档共享上成本较高,所以考虑弄...
    tobAlier阅读 3,891评论 0 5
  • 概述 GitBook 是使用 GitHub / Git 和 Markdown(或AsciiDoc)构建漂亮书籍的命...
    辉这样说阅读 3,018评论 0 4
  • GitBook 的使用笔记 因为近期想翻译一些英文技术文档和英文技术书籍,需要左右带有目录栏的电子书籍格式,所以找...
    九九丸子阅读 42,451评论 6 8
  • 1. GitHub 1.1. 创建账户 https://github.com/ 在上面注册账户: gitexam...
    蝴蝶泉nq阅读 4,632评论 1 3
  • 本文详细讲解了 Gitbook 生成电子书的完整过程,内容包括:安装、命令、配置、文档结构、生成电子书、部署。限于...
    静默虚空阅读 11,242评论 9 138