2014年6月23日 星期一

『Gitbook』用 Gitbook 寫一個教學的電子書

上面圖的內文請不要誤會,我沒有要談 swift language,我是因為看到這個 online help開始產生一點興趣,好奇著是不是有一個快速工具就搭建好的電子書,果然找到了!這套GitBook 是用 node.js 的 npm 管理工具搭建的一種建立電子書的套件,我們來看看要怎麼安裝跟建立文件



安裝

首先是安裝的部分,安裝之前請先確定 npm 這個管理工具有被安裝起來
     $sudo npm install -g gitbook


接著,先在某一個目錄夾裏建立一個電子書的檔案庫
     $gitbook serve ./repository

像這樣子

在製作這個電子書,特別要注意的是請先建立 README.mdSUMMARY.md 這兩個文件,因為這兩個文件代表著電子書的架構導覽
  • README.md   >>> 代表這本電子書的簡介
  • SUMMARY.md  >>> 定義這本電子書的章節結構

實作該怎麼做

在我們定義好 readme.md, summary.md 之後呢,可以看到我在 SUMMARY.md 檔案,建立了四個連結,分別是:
  • source/intro/first.md
  • source/install/secode.md
  • source/install/2-1.md
  • source/install/2-2.md
我們可以利用以下的指令,讓 gitbook 找到 summary.md 所定義的章節結構去自動地去產生對應的檔案

     $gitbook init

到建立 gitbook 的資料夾看,就可以看到自動建立 source 資料夾之外,在source 下層也建立 intro 及 install 這兩個資料夾,然後再進去看某個資料夾下後,可以發現 markdown 的空白檔案也已經自動建立起來,在這邊就可以隨心所欲去建置屬於自己的章節內容。

喔!等等,別忘了看看結果
內容寫好之後,建立一個靜態頁面,預設會開 port 4000 的網址

     $gitbook serve

可依照指令指示,開啓 http://localhost:4000

看看樣子

這是首頁的樣子,呈現的首頁就能閱覽我們在 README.md 所寫的內容

自定義的第一章節,在頁面上有個左右兩邊的箭頭,可以點選後翻到下一個章節
自定義的第二章節

BTW,

Gitbook 支援多種檔案格式:
  • 靜態網頁:這個是 Gitbook 預設的輸入格式
  • PDF : 需要安裝 gitbook-pdf 套件
  • eBook: 需要安裝 ebook-convert
  • 單一 HTML 網頁,支援將內容輸出成一個單頁的 html (但我沒用過,不知道@@)
  • JSON: 用在資料取得

ps. 在編寫 markdown 文件時,再存檔的時候會有 live reload 效果,即時更新頁面喔!酷耶~

沒有留言:

張貼留言