Gitbook

*增补

是什么

GitBook是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,GitBook 并非关于 Git 的教程。

为什么

  • 制作教程 教会半年前的自己 教是最好的学
  • 获得反馈
  • 可输出多种格式文件PDF epub mobi

现象

  • gitbook 升级后, 关联 github 有问题

分析

  • gitbook 服务升级, github 的 hook 没有对应升级
  • 虽然增加了 webhook 但是还是出现 github与gitbook不同步现象 即 push to github 而 gitbook 没有对应改变 或者 改变较慢(当然自己自己目前发现 我的add webhook过程见 webhook setup) 只能用double push 增补
    • push to github
    • push to gitbook

问题

  • 多个仓库的自动化同步,官方不支持了.

方案

~ 作为不折腾会死星人,当然有姿势解决所有问题...

双推 double push *增补

所谓双推 就是将本地working directory(or我称其为Local Repo)的内容 即push到 Github 仓库 又推送到 Gitbook

实现

一推 github

  • 我在Github Fork(相当于复制为我所用)学员模板仓库 我要基于该模板仓库建立自己学习开智编程课的教程 并改名为pybeginner 该远程库ssh为 [email protected]:JeremiahZhang/pybeginner.git
  • 在我的电脑端本体建立文件目录(文件夹) 比如我建立的是名为pybeginner的文件夹(我称其为Local Repo 本地仓库)
    • git init 初始化 以便与远程Repo连接
    • git remote add hub [email protected]:JeremiahZhang/pybeginner.git 此处我将Local Repo与Github Repo远程仓库建立连接 这里hub是我定义Github repo的名字 而ssh值我add的是代表Github上的pybeginner仓库
    • git branch --track hub master
    • git pull hub master 以上将我的 github repo pybeginner拉回(传送 如星际迷航中的瞬间传送)本地local repo
    • 以后我只要在local repo编辑内容 再push 到github 就OK了
      • git add README.md 修改了README.md文件 通过 git add 添加到staging area
      • git commit -m "modified README.md" 提交到git repository
      • git push -u hub master 推到github

已经推到了Github这是一推 下面需要另一推才能形成二推

二推 gitbook

  • Gitbook网页建立我的书籍 Python Beginner Guide For Leiyu 并找到 该书的 Git url 在书籍主页右下角 Setup 中 比如本书的git url为https://git.gitbook.com/jeremiahzhang/pybeginner.git
  • $git remote add book https://username:[email protected]/jeremiahzhang/pybeginner.git 建立Local repo与gitbook repo的连接 其中username为gitbook的名称 apitoken是每个Gitbook账户特有的 可以在Account setting中找到 book为对应gitbook repo名字 可以自己命名的
  • git push -u book master 将Local repo 推送到 gitbook

以上就是 双推 double push

Disqus 评论 *增补

gitbook 还支持许多插件,用户可以从 NPM 上搜索 gitbook 的插件,gitbook 文档 推荐插件的命名方式为:

  • gitbook-plugin-X: 插件
  • gitbook-theme-X: 主题

所以,可以通过以上两种方式来搜索 gitbook 的插件或者主题

作为一个非常流行的为网站集成评论系统的工具,Gitbook可以集成Disqus 便于和读者进行交流 好形成反馈

  • 1 首先注册Disqus 参考配置 Disqus
  • 2 install disqus plugin

    $ npm install gitbook-plugin-disqus -g

  • 3 增加book.json文件 代码如下

          {
          "plugins": ["disqus"],  
          "pluginsConfig": {  
          "disqus": {  
              "shortName": "XXXXXXX"  
                  }
              }  
          }
    
  • 效果
    • 在每一个页面都出现一下Disqus评论窗口

disqus01

详细可参考我的 折腾GitbookGuide

进展

  • 150317 大妈创建
  • 151007 雷雨增补