如何編輯
目前已經是多人共同編輯,比較推薦大家 git clone 回去離線編輯,雖然可以可以線上編輯。
我個人比較推薦使用的編輯器是 sublime text 3 如果有個人偏好的編輯器也是可以的。
如果你剛好使用 Mac OSX 系統,也可以選擇使用 MacDown
sublime text 3 安裝設定
- 下載安裝 sublime text 3
- 安裝 package control
- 重啟 sublime text 3
- 安裝 markdown 套件,我這邊使用的是 MarkdownLight
- 安裝方法是按下 cmd/ctrl + shift + p,輸入 install package 按下 enter
- 輸入套件 MarkdownLight 按下 enter
安裝 gitbook 離線預覽用
- 安裝 nodejs
- command line 輸入 npm install gitbook -g
- 移置 repo 目錄下
- conmand line 輸入 gitbook install 安裝套件,這邊有使用 disqus 的留言套件
- 可透過 gitbook serve -p portNumber 修改 port,預設為 4000
- 最後 gitbook serve 可以開啟 gitbook 離線伺服器預覽
Gitbook Markdown 使用方式
- 可以參考 gitbook 官方的說明文件
- 可自己新增要編輯的檔案 ex: gson.md
- 如果想寫的套件沒有在列表內,可以自行到 summary.md 新增
- 再麻煩各位到 readme.md 加上作者資訊及主要撰寫的章節
注意事項
- 本書使用 gitflow 編輯
- 如果不會使用 gitflow 可以參考 ihover 大寫的文章
- 指令不熟的話推薦使用 SourceTree 內建 gitflow
- 撰寫內容可以開 feature
- 錯誤修改可以開 hotfix
- 最後我會再將你們的內容 release 出來