人人都可快速上手的GitBook使用笔记

gitbook-logo.jpg

介绍

GitBook是Markdown与HTML完美的结合。

百科介绍：GitBook是一个基于Node.js的命令行工具，可通过Markdown来制作电子书、在线文档等。
GitBook支持输出多种格式：

1. PDF： 需要安装gitbook-pdf依赖；
2. eBook： 需要安装ebook-convert；
3. 单HTML网页： 支持将内容输出为单页的HTML。

前置条件

• 需要安装Node.js；
• 安装GitBook命令行工具；
• MarkDown常用语法；

本文介绍环境配置

• NPM版本： 5.6.0
• OS版本：Windows10
• CLI version: 2.3.2
• GitBook version: 3.2.3

相关网站

• Gitbook好用的插件：https://plugins.gitbook.com/
• Gitbook使用文档：https://github.com/GitbookIO/gitbook

使用步骤

GitBook的初始化，编译和预览等均需要在命令行进行，就像hexo编写个人博客一样。

安装GitBook工具

npm install gitbook-cli -g

初始化

新建一个目录，命令行打开该目录，然后以下输入命令，就可以初始化书籍，生成两个文件（没有生成其他教程说的book.json）：

• <code>README.md</code>：书籍介绍
• <code>SUMMARY.md</code>：书籍目录

gitbook init

编译成html

生成的文件在上述目录下的_book文件夹下

gitbook build

本地进行预览

浏览器中打开http://localhost:4000进行预览。

gitbook serve

相关命令

gitbook update # 更新gitbook

手动给GitBook添加book.json

因为使用<code>gitbook init</code>生成的目录默认是没有book.json的，那么要引入其他的插件的话就需要自己手动在根目录创建一个<code>book.json</code>，
配置之后需要使用<code>gitbook install</code>安装<code>book.json</code>中配置的插件。
基本格式如下：

  {
    "gitbook": "3.2.3",
    "title": "标题",
    "description": "文档描述",
    "author": "作者",
    "language": "zh-hans",
    "links": {
      "gitbook": true,
      "sharing": {
        "google": false,
        "facebook": false,
        "twitter": false,
        "all": false
      }
    },//分享按钮是否展示
    "plugins": [
      "github",
      "donate",
      "splitter",
      "anchor-navigation-ex",
      "-sharing",
      "sharing-plus",
      "-highlight",
      "prism",
      "disqus",
      "editlink",
      "baidu",
      "sitemap",
      "tbfed-pagefooter",
      "fontsettings",
      "simple-page-toc",
      "links"
    ],
    "pluginsConfig": {
      "tbfed-pagefooter": {
        "copyright": "",
        "modify_label": "文件修改时间：",
        "modify_format": "YYYY-MM-DD HH:mm:ss"
      },// 文件的修改时间，以及版权声明等
      "simple-page-toc": {
        "maxDepth": 3,
        "skipFirstH1": true
      },
      "sharing": {
        "douban": false,
        "facebook": false,
        "google": false,
        "hatenaBookmark": false,
        "instapaper": false,
        "line": false,
        "linkedin": false,
        "messenger": false,
        "pocket": false,
        "qq": false,
        "qzone": false,
        "stumbleupon": false,
        "twitter": false,
        "viber": false,
        "vk": false,
        "weibo": false,
        "whatsapp": false,
        "all": [
          "weibo",
          "qq",
          "qzone",
          "google",
          "douban"
        ]
      },
      "github": {
        "url": "https://github.com/nelucifer"
      },
      "donate": {
        "wechat": "",
        "title": "",
        "button": "赏",
        "wechatText": "微信打赏"
      },
      "anchor-navigation-ex": {
        "associatedWithSummary": false,
        "showLevel": true,
        "multipleH1": true,
        "mode": "float",
        "pageTop": {
          "showLevelIcon": false,
          "level1Icon": "fa fa-hand-o-right",
          "level2Icon": "fa fa-hand-o-right",
          "level3Icon": "fa fa-hand-o-right"
        }
      },
      "theme-default": {
        "showLevel": true
      },
      "fontsettings": {
        "theme": "white",
        "family": "serif",
        "size": 2
      },// 显示样式以及文字大小的主题
      "sidebar": {
      },
      "disqus": {
        "shortName": "webpack-handbook" //生成评论
      },
      "github": {
        "url": "https://github.com/nelucifer/front-template"
      },
      "editlink": {
        "base": "https://github.com/nelucifer/",
        "label": "编辑本页面" //内容顶部显示 编辑本页 链接，点击跳转到配置的源码存放位置
      },
      "baidu": {
        "token": "" //百度站长工具统计
      },
      "sitemap": {
        "hostname": "http://baidu.com/"//站点地图
      },
      "prism": {
        "css": [
          "prismjs/themes/prism-tomorrow.css"
        ]
      }
    }
  }

欢迎关注微信公众号weyoung，记录学习笔记和一些有趣的东西，欢迎交流~~

个人微信公众号weyoung
更多联系方式

平台	链接
个人博客	https://www.wanglixia.top/
预览项目：	https://nelucifer.gitee.io/
个人微信公众号：	weyoung
segmentfault:	https://segmentfault.com/u/nelucifer
CSDN:	https://me.csdn.net/wlx001
简书：	https://www.jianshu.com/u/99211cc23788
掘金：	https://juejin.im/user/59b08c575188250f4850e80e