用 Github、Markdown 和 GitBook 寫開源書

時間 2019-11-08

原文原文鏈接

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

以前一直是在 Github 上寫開源書（見：http://www.waylau.com/books/）但，因爲 Github 自己的目錄結構並不必定符合閱讀的習慣，並且沒有提供 pdf , ePUB, MOBI 等格式的轉換下載。不少同窗也仍是習慣離線看文檔。GitBook 就是解決這一問題。git

GitBook 讓你在保持在 Github 的書寫習慣外，稍加配置，就能自動發佈到GitBook 上，造成界面漂亮的電子書了（支持 html, pdf , ePUB, MOBI 等）。github

apache

若是你是第一次使用 GitBook,能夠參見使用 GitBook 寫開源書markdown

下面介紹，若是將一個 Github 項目轉移到 GitBook 上來架構

##註冊帳戶工具

須要擁有 Github 和 GitBook 的帳戶ui

##關聯帳號code

將 GitBook 的項目關聯上 Github 的庫htm

##原有的項目

這個是原來的項目結構，參見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/