美文网首页
gitbook的简单使用

gitbook的简单使用

作者: Lusia_ | 来源:发表于2017-07-31 00:50 被阅读144次

    GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书。
    GitBook支持输出以下几种文档格式:

    • 静态站点:GitBook默认输出该种格式
    • PDF:需要安装gitbook-pdf依赖
    • eBook:需要安装ebook-convert

    1、gitbook的安装

    首先要确保安装了node (node -v 检测是否安装,未安装去node官网下载安装)
    然后安装gitbook:

    sudo npm install gitbook-cli -g   // 安装gitbook
    gitbook --version  // 查看是否安装成功
    gitbook help  // 查看gitbook命令
    

    2、简单使用

    • 使用 gitbook init 初始化书籍目录
    • 使用 gitbook serve 编译书籍

    首先,创建如下目录结构:(README.md、SUMMARY.md2个必要文件)

    book/
    ├── README.md
    └── SUMMARY.md
    

    其中 README.md 是对书籍的简单介绍:

    $ cat book/README.md 
    # README 
    This is a book
    

    SUMMARY.md是书籍的目录结构:

    $ cat book/SUMMARY.md 
    # SUMMARY
    * [Chapter1](chapter1/README.md)
      * [Section1.1](chapter1/section1.1.md)
      * [Section1.2](chapter1/section1.2.md)
    * [Chapter2](chapter2/README.md)
    

    创建2个文件后,使用gitbook init ,它会为我们创建 SUMMARY.md中的目录结构

    书籍目录创建成功后,就可以使用gitbook serve来编译和预览书籍了!!
    gitbook serve命令实际上会先调用gitbook build编译书籍,完成以后会打开一个web服务器,监听在本地的4000端口。

    3、结合github存储书籍

    创建 gh-pages 分支 用于展示静态资源
    执行如下命令来创建分支,并且删除不需要的文件:(实际中只用了git checkout --orphan gh-pages)

    $ git checkout --orphan gh-pages
    $ git rm --cached -r .
    $ git clean -df
    $ rm -rf *~
    

    现在,目录下应该只剩下 _book 目录了,首先,忽略一些文件:

    $ echo "*~" > .gitignore
    $ echo "_book" >> .gitignore
    $ git add .gitignore
    $ git commit -m "Ignore some files"
    

    然后,加入 _book 下的内容到分支中:

    $ cp -r _book/* .
    $ git add .
    $ git commit -m "Publish book"
    

    然后就可以访问 用户名+ github.io + 项目名称,例如https://wylibra.github.io/gitbook

    相关文章

      网友评论

          本文标题:gitbook的简单使用

          本文链接:https://www.haomeiwen.com/subject/ijhllxtx.html