寫書環境 Gitbook + SourceTree + MarkdownPad

今年年初定的計劃是要自己寫一些成段的文字,看起來像書的文字,研究了下決定使用

  • Gitbook
  • SourceTree

  • MarkdownPad

用gitbook寫書至少不需要太多考慮格式,基於markdown生成網頁和pdf,epub等;所有commit均有記錄,方便合作寫書。

正在書寫的幾本書,都是和IC相關的,還有自己寫的應用的開發文檔和使用文檔。

QFShare 自編書首頁 book.qfshare.com

  • Tcl 基礎 - 和IC結合精密的Tcl教程

  • CAD 話題 - 零碎的CAD問題和解決方案

  • Tcl 進階 - 一些Tcl的高級話題

  • MYWM - 為IC工程師定製工作首頁

所有書均在書寫中,如有任何形式的合作意向,私信我。

安裝Gitbook

直接使用gitbook 官方或者安裝gitbook到伺服器。

gitbook 官方對於開源書籍的脫管是免費的,而且還有gitbook editor 這個客戶端使用。

下面來看怎麼在自己的伺服器上部署和發布。

首先你必須安裝node.js和npm,首先我們來安裝一個nvm,用於node 的 version management。

$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.1/install.sh | bashn

然後安裝node.js

$ nvm install 6.10.2n

再安裝npm

curl http://npmjs.org/install.sh | shn

現在可以安裝gitbook了。

$ npm install gitbook-cli -gn

需要把相應的路徑放入PATH 這個環境變數。

使用SourceTree 和MarkdownPad

SourceTree 是很好的git管理工具,我使用它來同步多個git 源(內網,外網同步),很多我感興趣的,還沒有時間細細看的暫時都歸類在裡面。

MarkdownPad 是當年剛接觸Markdown的時候,沒有找到一款好的編輯器,不像現在,在線的,離線的都做得很晚上,總體來說這款商業軟體還是不錯的。當然現在的很多開源的程序也不遜色。

開始寫書

新建一個git 的repository,在github 上也好,在自己的伺服器上也好(比如 git.qfshare.com/book/my),然後建立一些gitbook 需要的文件。

  • README.md

  • SUMMARY.md

  • book.json

  • cover.jpg
  • cover_small.jpg
  • .gitignore

幾個關鍵文件,README.md 可以做為介紹放入書中,也是git 的介紹頁。

SUMMARY.md 定義了說本的結構,當這個寫好後,可以用下面的命令來初始化所有的文件和目錄。

$ gitbook initn

book.json 中可以定義一些比如標題,作者,使用的gitbook 插件等。使用下面這個命令可以將插件自動安裝好。

$ gitbook installn

cover*.jpg 是在生成PDF的時候,可以給書本添加封面,推薦尺寸為:

conver.jpg: 1800x2360

conver_small.jpg: 200x262

寫完各章節的Markdown之後,進行書本的編譯。默認會將html 的文檔編譯到_book 目錄中,pdf 等電子書格式在當前目錄下。

$ gitbook buildn$ gitbook pdfn

然後將_book 放於網站能訪問的目錄中,或者編譯的時候直接編譯到網站目錄。


推薦閱讀:

IC 實現數據收集 - Floorplan
離職華為創辦「加速雲」,Eric帶你探索FPGA在人工智慧的應用
數字ic前端和後端等學習路線是什麼?
就數字IC來說,驗證、前端、後端這三個方向將來哪個更好發展點呢?
如何理解「一個always裡面只輸出一個信號,避免互相干擾」?

TAG:GitBook | Tcl语言 | 数字IC设计 |