gitbook安裝指南

文章目錄

0.簡(jiǎn)介

1.安裝nodejs

2.查看nodejs是否安裝成功

3.安裝gitbook

4.typora下載與安裝

5.創(chuàng)建電子書(shū)

6.查看所有命令

7.常用命令

8 GitBook主頁(yè) [https://www.gitbook.com/]

9 目錄

10 配置

title

author

description

language

gitbook

root

links

styles

plugins

pluginsConfig

structure

0.簡(jiǎn)介

這是 gitbook 項(xiàng)目主頁(yè)上對(duì) gitbook 的定義。

gitbook 首先是一個(gè)軟件，正如上面定義的那樣，它使用 Git 和 Markdown 來(lái)編排書(shū)本，

如果用戶(hù)沒(méi)有聽(tīng)過(guò) Git 和 Markdown，那么 gitbook 可能不適合你！

1.安裝nodejs

http://nodejs.cn/download/

2.查看nodejs是否安裝成功

node -v

1

3.安裝gitbook

npm install gitbook-cli -g

查看是否安裝成功

gitbook -V

1

4.typora下載與安裝

http://mydown.yesky.com/pcsoft/107253300.html

https://typora.io/

typora

來(lái)編輯markdown文檔

5.創(chuàng)建電子書(shū)

gitbook init

失敗，使用該命令清空緩存

npm cache clean

6.查看所有命令

gitbook help

7.常用命令

gitbook init gitbook項(xiàng)目初始化。 gitbook serve 啟動(dòng)gitbook項(xiàng)目并提供http://localhost:4000為瀏覽器瀏覽鏈接。 gitbook help //列出gitbook所有的命令 gitbook --help //輸出gitbook-cli的幫助信息 gitbook build //生成靜態(tài)網(wǎng)頁(yè) gitbook serve //生成靜態(tài)網(wǎng)頁(yè)并運(yùn)行服務(wù)器 gitbook build --gitbook=2.0.1 //生成時(shí)指定gitbook的版本, 本地沒(méi)有會(huì)先下載 gitbook ls //列出本地所有的gitbook版本 gitbook ls-remote //列出遠(yuǎn)程可用的gitbook版本 gitbook fetch 標(biāo)簽/版本號(hào) //安裝對(duì)應(yīng)的gitbook版本 gitbook update //更新到gitbook的最新版本 gitbook uninstall 2.0.1 //卸載對(duì)應(yīng)的gitbook版本 gitbook build --log=debug //指定log的級(jí)別 gitbook builid --debug //輸出錯(cuò)誤信息 gitbook build[path] 構(gòu)建gitbook項(xiàng)目，構(gòu)建路徑可省略，默認(rèn)為_(kāi)book

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

8 GitBook主頁(yè) [https://www.gitbook.com/]

9 目錄

GitBook 基本的目錄結(jié)構(gòu)如下所示

├── book.json

├── README.md

├── SUMMARY.md

├── chapter-1/

| ├── README.md

| └── something.md

└── chapter-2/

├── README.md

└── something.md

這里主要講下 GitBook 預(yù)定義的幾個(gè)文件的作用

1

book.json

存放配置信息，在下一章中所講的配置信息都是在這個(gè)文件里定義的，關(guān)于該文件的配置可以看 配置 這個(gè)章節(jié)。

Summary

概要文件主要存放 GitBook 的文件目錄信息，左側(cè)的目錄就是根據(jù)這個(gè)文件來(lái)生成的，默認(rèn)對(duì)應(yīng)的文件是 SUMMARY.md，可以在 book.json 重新定義該文件的對(duì)應(yīng)值。它通過(guò) Markdown 中的列表語(yǔ)法來(lái)表示文件的父子關(guān)系，下面是一個(gè)簡(jiǎn)單的示例：

# Summary * [Introduction](README.md) * [Part I](part1/README.md) * [Writing is nice](part1/writing.md) * [GitBook is nice](part1/gitbook.md) * [Part II](part2/README.md) * [We love feedback](part2/feedback_please.md) * [Better tools for authors](part2/better_tools.md)

1

2

3

4

5

6

7

8

這個(gè)配置對(duì)應(yīng)的目錄結(jié)構(gòu)如下所示:

我們通過(guò)使用 標(biāo)題 或者 水平分割線 標(biāo)志將 GitBook 分為幾個(gè)不同的部分

# Summary ### Part I * [Introduction](README.md) * [Writing is nice](part1/writing.md) * [GitBook is nice](part1/gitbook.md) ### Part II * [We love feedback](part2/feedback_please.md) * [Better tools for authors](part2/better_tools.md) ---- * [Last part without title](part3/title.md)

1

2

3

4

5

6

7

8

9

10

11

12

13

14

這個(gè)配置對(duì)應(yīng)的目錄結(jié)構(gòu)如下所示：

Glossary

詞匯表文件，默認(rèn)對(duì)應(yīng)的文件是 GLOSSARY.md。該文件主要存儲(chǔ)詞匯信息，如果在其他頁(yè)面中出現(xiàn)了該文件中的詞匯，鼠標(biāo)放到詞匯上會(huì)給出詞匯示意，可以將鼠標(biāo)移到下面兩個(gè)詞匯上看下效果。

## Git 分散式版本控制軟件 ## Markdown Aaron Swartz 跟John Gruber共同設(shè)計(jì)的排版語(yǔ)言

1

2

3

4

5

10 配置

title - 標(biāo)題

description - 書(shū)本描述

language - 使用的語(yǔ)言

gitbook - 指定gitbook版本

root - 指定存放 GitBook 文件的根目錄

links - 在側(cè)邊欄添加鏈接

styles - 自定義樣式

plugins - 插件

pluginsConfig - 插件配置

structure - 設(shè)置 Readme, Summary, Glossary等對(duì)應(yīng)的文件

title

設(shè)置書(shū)本的標(biāo)題

“title” : “Gitbook Use”

author

“author” : “zhangjikai”

description

本書(shū)的簡(jiǎn)單描述

“description” : “記錄Gitbook的配置和一些插件的使用”

language

Gitbook使用的語(yǔ)言, 版本2.6.4中可選的語(yǔ)言如下：

en, ar, bn, cs, de, en, es, fa, fi, fr, he, it, ja, ko, no, pl, pt, ro, ru, sv, uk, vi, zh-hans, zh-tw

配置使用簡(jiǎn)體中文

“l(fā)anguage” : “zh-hans”,

gitbook

指定使用的gitbook版本

“gitbook” : “3.2.2”,

“gitbook” : “>=3.0.0”

root

指定存放 GitBook 文件（除了 book.json）的根目錄

“root”: “.”

links

在左側(cè)導(dǎo)航欄添加鏈接信息

“l(fā)inks” : {undefined

“sidebar” : {undefined

“Home” : “http://zhangjikai.com”

}

}

styles

自定義頁(yè)面樣式， 默認(rèn)情況下各generator對(duì)應(yīng)的css文件

“styles”: {undefined

“website”: “styles/website.css”,

“ebook”: “styles/ebook.css”,

“pdf”: “styles/pdf.css”,

“mobi”: “styles/mobi.css”,

“epub”: “styles/epub.css”

}

例如使

標(biāo)簽有下邊框， 可以在website.css中設(shè)置

h1 , h2{undefined

border-bottom: 1px solid #EFEAEA;

}

plugins

配置使用的插件

“plugins”: [

“disqus”

]

添加新插件之后需要運(yùn)行g(shù)itbook install來(lái)安裝新的插件

Gitbook默認(rèn)帶有5個(gè)插件：

highlight

search

sharing

font-settings

livereload

如果要去除自帶的插件， 可以在插件名稱(chēng)前面加-

“plugins”: [

“-search”

]

pluginsConfig

配置插件的屬性

“pluginsConfig”: {undefined

“fontsettings”: {undefined

“theme”: “sepia”,

“family”: “serif”,

“size”: 1

}

}

structure

指定 Readme、Summary、Glossary 和 Languages 對(duì)應(yīng)的文件名，下面是這幾個(gè)文件對(duì)應(yīng)變量以及默認(rèn)值：

Git GitHub

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶(hù)投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請(qǐng)聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶(hù)投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容，請(qǐng)聯(lián)系我們jiasou666@gmail.com 處理，核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。