gitbook使用入門


GitBook 是一個基於 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 來制作精美的電子書。GitBook支持輸出以下幾種文檔格式

  • 靜態站點:GitBook默認輸出該種格式

  • PDF:需要安裝gitbook-pdf依賴

  • eBook:需要安裝ebook-convert

新接觸的時候要大概理解這個軟件的意義,是基於git的分布式文本編輯。一個組織中的多個人,合作寫一個文本,大家都可以使用獨立的分支,可以分開可以合並,大家都是master也都是origin; 

1 先行安裝Node.js、GitBook、GitBook Editor、Git版本控制器

node -v //顯示v4.5.0 驗證是否安裝成功;

npm install gitbook -g 命令行安裝gitbook;

npm install -g gitbook-cli 安裝gitbook的命令行工具;

gitbook -V //顯示0.4.2 檢測是否成功;

卸載用npm uninstall -g gitbook

 

下載安裝gitbook editor 我這兒用的mac,安裝后使用;

我的實際情況時,公司在用gitlab,產品團隊一起編輯產品文檔,就需要拉下gitlab上的書,然后本地編輯,上傳后由管理員合並文檔;

拉下數據;初次可以直接下載 ;打開gitbook editor import 本地的書;

 

gitbook中書的刪除,這點困擾我很久,吐槽,新手肯定會新建書做測試,有潔癖的我非刪了ta不可。刪除很簡單,在dashboard里,書的后面,setting,在最后面有個delete;

- 現在開始,實際說明使用,因為我們裝了客戶cli,就拿cli來講,比較炫酷,其實也很方便;

第一個命令:gitbook init mybook  初始化一本書,名字叫 mybook;(更多命令可看 gitbook helo,統共8個,不要虛);

這時候就見

warn: no summary file in this book 

info: create README.md 

info: create SUMMARY.md 

info: initialization is finished

因為本來沒這本書的,所以新建了 readme.md (封面)、summary.md(目錄);

接着我們就可以開始編輯書的內容了;

如何編寫:

gb的文檔規范為markdown語法,非常簡單,不贅述,可以看 http://www.appinn.com/markdown/  個人使用感覺,如果用太麻煩的語法,就失去了意義,還不如直接拿word方便。

編寫完成后,適用 gitbook serve $bookname ,然后就能在localhost:4000里查看了。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM