基于 Github 项目创建 GitBook 在线电子书

作者: judasn 分类: Github 发布时间: 2017-07-03 10:14

场景说明

  • 由于我个人有用 Github 写东西的习惯,我自己有 VPS,所以用 Github 看东西并不会觉得麻烦。
  • 只是有部分童鞋喜欢用 GitBook 看内容,所以就有了这篇文章的产生。
  • GitBook 可以不依赖 Github 进行使用的,可以单独在 GitBook 网页上写文章,也可以本地安装 node.js 中 gitbook 相关模块把 markdown 文件生成相应的 html、pdf 等电子书格式。
  • 我个人推荐大家使用 Github 进行写作,然后再授权给 GitBook 进行读取。养成 Github 习惯是很有必要的。

前提

Github 授权给 GitBook

绑定 Github 账号

  • 如上图,登录你的 GitBook 账号,在 Account Settings 中设置 GitBook 读取你 Github 权限相关。

Github 授权控制

  • 如上图,你的 Github 也可以看到相应授权的详细信息。

Github 项目中必有文件

  • 使用 GitBook 制作电子书,命名约束上必备两个文件:README.md 和 SUMMARY.md
  • 其中 README.md 作为电子书的简介内容,SUMMARY.md 用来定义电子书章节结构
  • README.md 内容格式无限制
  • SUMMARY.md 推荐下面格式,下面是一个 3 级的目录结构(其中 SUMMARY.md 和这些文章 markdown 文件是在同级目录下):
* [Linux 介绍](Linux.md)
    * [Ubuntu 介绍](Ubuntu.md)
        * [Ubuntu 安装](Ubuntu-Install.md)
        * [Ubuntu 设置(目录)](ubuntu-settings-toc.md)
        * [Ubuntu 安装 VMware](Ubuntu-Install-VMware.md)
    * [CentOS 介绍](CentOS.md)
        * [CentOS 6 安装](CentOS-Install.md)
        * [CentOS 7 安装](CentOS-7-Install.md)
        * [CentOS 6 和 CentOS 7 差异](CentOS6-and-CentOS7.md)
        * [CentOS 设置(目录)](centos-settings/centos-settings-toc.md)

GitBook 读取 Github 项目文件创建电子书

GitBook 创建电子书

  • 如上图,点击右上角的:+ New 读取 Github 中指定项目创建一个电子书。
  • 如果你 Github 中的 markdown 文件格式写得有问题,可能会创建不了。
  • 推荐 Github 项目中一定有一个 master 默认分支,不然可能也无法创建。

希望对你有帮助!