用 Github、Markdown 和 GitBook 写开源书

最新推荐文章于 2020-11-05 19:55:33 发布

weixin_34380948

最新推荐文章于 2020-11-05 19:55:33 发布

阅读量104

点赞数

文章标签： markdown

原文链接：https://my.oschina.net/waylau/blog/355179

版权

原文同步至：http://www.waylau.com/using-github-markdown-gitbook-write-open-source-books/

之前一直是在 Github 上写开源书（见：http://www.waylau.com/books/）但，由于 Github 本身的目录结构并不一定符合阅读的习惯，而且没有提供 pdf , ePUB, MOBI 等格式的转换下载。很多同学也还是习惯离线看文档。GitBook 就是解决这一问题。

GitBook 让你在保持在 Github 的书写习惯外，稍加配置，就能自动发布到GitBook 上，形成界面漂亮的电子书了（支持 html, pdf , ePUB, MOBI 等）。

如果你是第一次使用 GitBook,可以参见使用 GitBook 写开源书

下面介绍，如果将一个 Github 项目转移到 GitBook 上来

##注册账户

需要拥有 Github 和 GitBook 的账户

##关联账号

将 GitBook 的项目关联上 Github 的库

##原有的项目

这个是原来的项目结构，参见https://github.com/waylau/apache-shiro-1.2.x-reference。

##添加 SUMMARY.md 文件配置

不改变原有的项目结构，添加 SUMMARY.md 文件，描述了 GitBook 目录结构，如下：

# Summary

This is the summary of my book.

* I. Overview 总览
	* [1. Introduction 介绍](I. Overview 总览/1. Introduction 介绍.md) 
	* [2. Tutorial 教程](I. Overview 总览/2. Tutorial 教程.md) 
	* [3. Architecture 架构](I. Overview 总览/3. Architecture 架构.md) 
	* [4. Configuration 配置](I. Overview 总览/4. Configuration 配置.md) 
* II. Core 核心
	* [5. Authentication 认证](II. Core 核心/5. Authentication 认证.md) 
	* [6. Authorization 授权](II. Core 核心/6. Authorization 授权.md) 
* III. Web Applications
* IV. Auxiliary Support 辅助支持
* V. Integration 整合
* VI. Tools 工具
* VII. Index 目录
* VIII. Other 其他

##编译

$ gitbook build ./

编译成功后，生成 _book 目录

##运行

运行 _book 目录中的index.html

效果

##提交更新到 Github，自动发布到 GitBook

提交代码到 Github 的库，由于 GitBook 的项目关联上 Github 的库，所以 GitBook 会自动根据 Github 进行发布。效果如下： <a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/16_zpsae785ba0.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/16_zpsae785ba0.jpg" border="0" alt=" photo 16_zpsae785ba0.jpg"/></a>

在线电子书：http://waylau.gitbooks.io/apache-shiro-1-2-x-reference/

转载于:https://my.oschina.net/waylau/blog/355179