用 GitBook 創建一本書


用 GitBook 創建一本書

Gitbook 首先是一個軟件,它使用 Git 和 Markdown 來編排書本,如果你沒有聽過 Git 和 Markdown,那么 gitbook 可能不適合你直接入手,你需要先去學習 Git 和 Markdown。Git 是一個版本控制工具,Markdown 是一個文本編輯語法,基本的使用大概幾個小時就可以都學會了,並不復雜。

這是 Gitbook 項目主頁上對 Gitbook 的定義。

Modern book format and toolchain using Git and Markdown .

安裝 GitBook

首先需要安裝 nodejs,以便能夠使用 npm 來安裝 gitbook

$ wget -qO- https://raw.github.com/creationix/nvm/v0.33.11/install.sh | sh

該命令會安裝 nvm 命令,安裝好以后會添加 nvm 的環境變量到 .bashrc 文件里,接下來退出終端,重新登陸使得 .bashrc 文件生效,或者使用其他方法使添加的環境變量生效。

接下來使用下列命令來安裝 npm

$ nvm install stable

可以使用下列命令來查看 npm 的版本,比如我這次安裝的是 6.11.3 版本。

[erdong@testhost ~]$ npm --version
6.11.3
[erdong@testhost ~]$

接下來使用 npm 來安裝 gitbook

$ npm install gitbook-cli -g

創建第一本書

首先新建一個目錄,這個目錄就是這本書的一個載體,就好比在現實世界里你要先准備一個本子,以后所有的內容會寫在這個本子上。在 gitbook,我們以后所有的內容都會存放在這個目錄里。

$ mkdir erdong-first-book

接下來我們初始化這個目錄,就好比你在你准備的本子上做一些基本的工作,

[erdong@testhost ~]$ cd erdong-first-book
[erdong@testhost erdong-first-book]$ gitbook init
[erdong@testhost erdong-first-book]$ ls
README.md  SUMMARY.md

初始化過后,在這個文件夾會生成 2 個文件,README.mdSUMMARY.md

  • README.md : 是書的簡單介紹,類似於一本書的序或者前言部分。
  • SUMMARY.md : 是書的目錄,程序按照這個文件來生成書的結構。

初始化結束后,就可以寫東西了,

比如我們現在往這兩個文件里寫入以下內容,在 README.md 文件中我們寫入如下內容:

# Introduction

This erdong's first book

This a samples in GitHub, https://github.com/erdong/gitbook-notes-samples

在 SUMMARY.md 文件中寫入如下內容:

# Summary

* [Introduction](README.md)

* [Part I]()
* [Part II]()
* [Part III]()

寫入內容后,我們可以通過 gitbook serve 命令來預覽我們寫的書

[erdong@testhost erdong-first-book]$ gitbook serve
Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.5s !

Starting server ...
Serving book on http://localhost:4000

這樣會在前台運行一個 web 程序,對外以 4000 端口提供一個可以瀏覽的頁面,瀏覽的地址是 http://localhost:4000

這樣我們就可以查看我們寫好的書了。如下圖所示。

Gitbook Introduction

如果我們不想使用這種方式來預覽書籍的話,也可以用 gitbook 生成一份靜態的頁面,放在 web 服務器或者其他可以提供 web 瀏覽訪問的地方。生成靜態頁面使用 gitbook build 命令即可,會生成一個 _book 的文件夾,這個目錄里放的就是生成好的靜態頁面,拷貝到對應的目錄即可。

[erdong@testhost erdong-first-book]$ gitbook build 
info: 7 plugins are installed
info: 6 explicitly listed
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.5s !
[erdong@testhost erdong-first-book]$ 

小結

這樣,我們就通過 GitBook 工具寫了一本書,或者一個小冊子。


免責聲明!

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



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