用 GitHub、Markdown 和 GitBook 写开源书
之前一直是在 GitHub 上写开源书(见:http://www.waylau.com/books/)但,由于 GitHub 本身的目录结构并不一定符合阅读的习惯,而且没有提供 pdf , ePUB, MOBI 等格式的转换下载。很多同学也还是习惯离线看文档。GitBook 就是解决这一问题。
GitBook 让你在保持在 GitHub 的书写习惯外,稍加配置,就能自动发布到GitBook 上,形成界面漂亮的电子书了(支持 html, pdf , ePUB, MOBI 等)。
如果你是第一次使用 GitBook,可以参见 使用 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 进行发布。 效果如下:
在线电子书:http://waylau.gitbooks.io/apache-shiro-1-2-x-reference/