Python学习之路

GitBook 学习指南

Gitbook 简介

Gitbook是一个基于Node.js的命令行工具,可以把Markdown文件汇集成电子书,并提供PDF等多种格式输出。可以把Gitbook生成的HTML发布出来,形成一个静态网站。下面主要介绍安装、编写、生成和发布,以及Gitbook和Github的关联。

Gitbook安装

  1. 下载并安装node.js。去node.js官方网站下载,并参照教程安装;安装完成后,在终端输入检验如下:

     $ node -v 
     V0.12.0
    

    看到如上信息(第2行代表安装的版本)表示已经成功安装上Node.js

  2. Gitbook 是通过Npm 安装的。所以在安装完成Node.js后,输入代码:

     $ npm install gitbook -g
    

    2.1 遇到如下问题: 报错
    2.2 +sudo进行强推:

        $ sudo npm install gitbook -g (如代码反馈有错误,+sudo 进行强推)
    

    原来运用+sudo的方式能够安装,不过这次跳出如下代码:
    检验gitbook版本:

      $ gitbook -V
    

    跳出如下代码:
    2.3 按照提示,输入如下代码:

     $ sudo npm install -g gitbook-cli
    

    再次检验gitbook版本,显示如下:

     $ gitbook -V
     0.3.3
    

看到如上版本信息,就表示gitbook已经安装成功

Gitbook 图书编写与生成

  1. Gitbook需要2个基本文件:README.md和SUMMARY.md.
    README.md一般为写关于本书的大概介绍,而SUMMARY.md则包含了书目的章节结构,大致格式:

     *[缘起](/source/begin.md)  
     *[课前准备](/source/part1/introduction.md)
       *[时间&能量调集]()source/part1/1.md)
       *[硬件准备](/source/part1/2.md)
     *[第一周](/source/part2/introduction.md)      
       *[环境配置](/source/part2/1.md)
       *[开光大会心得总结](/source/part2/2.md)
    
  2. 目录初始化
    当生成了README.md和SUMMARY.md文件后,通过以下命令行(代码)将目录结构生成对应的文件

        $ gitbook init
    
    我们可以看到生成的对应文件,已经文件中都有一个README.md
    

Gitbook 双推教程

  1. 在github网站新建远程仓库,并将先前生成的本地仓库文件上传到远程仓库;
  2. 进入本地仓库,输入 vi ./.git/config 进入vi编辑界面,按i,进入编辑模式,在[remote "origin"]下一行,添加:url = gitbook的网址.效果如下:

     [remote "origin"]
            url = [email protected]:<id>/<name>.git
            url = https://git.gitbook.com/<id>/<name>.git
            fetch = +refs/heads/*:refs/remotes/origin/*
    

    补充:如何退出Vi编辑界面,esc 后输入:shift ZZ 或者wq!

3.在gitbook网站,找到对应的电子书,然后进入 GitHub integration, 关联github对应的仓库网址。
4.在终端输入:

git add -A
git commit -m "a"
git push -u origin +master

参考教程:

Gitbook教程
双推教程