GitBook本地服务搭建

前置依赖

  • NodeJS (v4.0.0 and above is recommended)
  • Windows, Linux, Unix, or Mac OS X

本地安装过程

1. 安装NodeJs

由于GitBook依赖NodeJ.js环境, 在 https://nodejs.org/ 下载并安装Node.js,此步骤具体安装过程不再此讨论,可以在网上查找相关资料。

2. 安装gitbook命令行工具

推荐使用npm安装GitBook,打开终端输入下面安装命令:

$ npm install gitbook-cli -g

安装成功后可以使用下面命令查看gitbook命令如何使用:

$ gitbook -h

3. 新建GitBook项目

新建一个GitBook项目很简单,只需要创建一个文件夹,然后使用GitBook命令进行初始化即可:

$ mkdir mybook
$ cd mybook
$ gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished

查看上述日志知道,gitbook初始化命令帮助我们在此文件夹下新建了两个文件:README.mdSUMMARY.md

$ ls
README.md  SUMMARY.md

4. 编辑SUMMARY.md文件,生成目录结构

GitBook使用SUMMARY.md文件组织整个内容的目录,如:

# Summary

* [简介](README.md)
* [第一节](Section1.md)
* [第二节](Section2.md)

.md文件使用markdown语法编辑,不清楚的同学可以自行Baidu Google。

5. 再次执行gitbook init生成文件目录

编写完SUMMARY.md文件后,可以再次使用gitbook init命令来生成目录对应的.md文件:

$ gitbook init
info: create Section1.md
info: create Section2.md
info: create SUMMARY.md
info: initialization is finished
$ ls
README.md   SUMMARY.md  Section1.md Section2.md

6. 编辑md文件内容

编辑其他.md文件,并在编辑结束后,执行gitbook init

7. 电子书预览

编辑电子书结束后,可以使用gitbook serve命令在本地预览效果:

$ gitbook serve

gitbook serve启动一个web服务, 默认使用4000端口,如果想更改端口,可以使用--port 端口参数更改:

$ gitbook serve --port 9000

在浏览器访问http://localhost:4000预览效果;

8. 电子书发布

可以使用gitbook build命令生成电子书的静态页面:

$ gitbook build

查看一下目录会发现,此命令会在当前目录生成_book目录,用于存放静态Html文件,用户可以将这个文件夹内容托管到网上,从而实现内容的发布。

$ ls
README.md   SUMMARY.md  Section1.md Section2.md _book

参考资料

Copyright © wychuan.com 2017 all right reserved,powered by Gitbook该文件修订时间: 2017-09-13 07:10:57

results matching ""

    No results matching ""