Gitbook最全初始配置


一、GitBook 簡介

gitbook 是一個基於node.js命令的工具,可以使用網絡常見的github|git和Markdown來制作精美的電子書,而且和typora軟件搭配是一款非常好的筆記記錄軟件,下面我們一起來了解它的入門需知吧

  • 語法簡單
  • 兼容性強
  • 導出方便
  • 專注內容
  • 團隊協作

二、安裝

安裝軟件:Git、Typora

Typora 下載地址:https://typora.io/

Git 下載地址:https://git-scm.com/downloads

安裝 Node.js

GitBook 是一個基於 Node.js 的命令行工具,下載安裝 [Node.js]https://nodejs.org/zh-cn/),安裝完成之后,你可以使用下面的命令來檢驗是否安裝成功。

三、使用

1.全局安裝gitbook-cli輸入下面的命令來安裝 GitBook。

npm install gitbook-cli -g

2.新建文件夾(英文命名 如:myboot)

gitbook init
README.md —— 書籍的介紹寫在這個文件里
SUMMARY.md —— 書籍的目錄結構在這里配置

3.啟動Typora編輯器,引入文件夾

4.編輯目錄SUMMARY.md

# Summary

* [目錄](README.md)
* [第一章](notes/1-0.md)
    * [第1節:](notes/1-1.md)
    * [第2節:](notes/1-2.md)
    * [第3節:](notes/1-3.md)
    * [第4節:](notes/1-4.md)
* [第二章](notes/2-0.md)
* [第三章](notes/3-0.md)
* [第四章](notes/4-0.md)

5.再次執行gitbook init,生成新目錄結構

6.瀏覽器瀏覽:gitbook serve

執行 gitbook serve 來預覽這本書籍,執行命令后會對 Markdown 格式的文檔進行轉換,默認轉換為 html 格式,最后提示 “Serving book on http://localhost:4000

7.構建書籍:gitbook build

  • [x] 默認:將生成的靜態網站輸出到 _book 目錄
  • [x] 指定路徑:gitbook build [書籍路徑] [輸出路徑]
  • [x] 指定端口:gitbook serve --port 2333
  • [x] 生成pdf格式:gitbook pdf ./ ./mybook.pdf
  • [x] 生成epub格式:gitbook epub ./ ./mybook.epub
  • [x] 生成 mobi 格式:gitbook mobi ./ ./mybook.mobi

注意:如果生成不了,你可能還需要安裝一些工具,比如 calibre、ebook-convert,或者在 Typora 中安裝 Pandoc 進行導出。

8.gitbook附加命令

npm i -g gitbook-cli |  npm install gitbook-cli -g  //安裝環境

gitbook init //初始化目錄文件

gitbook help //列出gitbook所有的命令

gitbook --help //輸出gitbook-cli的幫助信息

gitbook build //生成靜態網頁

gitbook serve //生成靜態網頁並運行服務器

gitbook build --gitbook=2.0.1 //生成時指定gitbook的版本, 本地沒有會先下載

gitbook ls //列出本地所有的gitbook版本

gitbook ls-remote //列出遠程可用的gitbook版本

gitbook fetch 標簽/版本號 //安裝對應的gitbook版本

gitbook update //更新到gitbook的最新版本

gitbook uninstall 2.0.1 //卸載對應的gitbook版本

gitbook build --log=debug //指定log的級別

gitbook builid --debug //輸出錯誤信息1234567891011121312345678910111213

四、目錄結構

GitBook 基本的目錄結構如下所示:

.
├── book.json
├── README.md
├── SUMMARY.md
├── notes/
|   ├── 1-0.md
|   └── 1-1.md
|   ├── 1-2.md
|   └── 1-3.md

  

下面我們主要來講講 book.json 和 SUMMARY.md 文件。

book.json

該文件主要用來存放配置信息,我先放出我的配置文件。

相信很多節點自己也能猜到是什么意思,我還是簡單介紹下吧。

title

本書標題

author

本書作者

description

本書描述

language

本書語言,中文設置 "zh-hans" 即可

gitbook

指定使用的 GitBook 版本

styles

自定義頁面樣式

structure

指定 Readme、Summary、Glossary 和 Languages 對應的文件名

在左側導航欄添加鏈接信息

plugins

配置使用的插件

pluginsConfig

配置插件的屬性

SUMMARY.md

這個文件主要決定 GitBook 的章節目錄,它通過 Markdown 中的列表語法來表示文件的父子關系,下面是一個簡單的示例:

# Summary

* [目錄](README.md)
* [第一章](notes/1-0.md)
    * [第1節:](notes/1-1.md)
    * [第2節:](notes/1-2.md)
    * [第3節:](notes/1-3.md)
    * [第4節:](notes/1-4.md)
* [第二章](notes/2-0.md)
* [第三章](notes/3-0.md)
* [第四章](notes/4-0.md)

這個配置對應的目錄結構如下所示:

我們通過使用 標題 或者 水平分割線 將 GitBook 分為幾個不同的部分,如下所示:

# Summary

### Part I

* [目錄](README.md)

### Part II

* [第一章](notes/1-0.md)
    * [第1節:](notes/1-1.md)
    * [第2節:](notes/1-2.md)
    * [第3節:](notes/1-3.md)
    * [第4節:](notes/1-4.md)

---

* [第二章](notes/2-0.md)
* [第三章](notes/3-0.md)
* [第四章](notes/4-0.md)

插件

GitBook 有 插件官網,默認帶有 5 個插件,highlight、search、sharing、font-settings、livereload,如果要去除自帶的插件, 可以在插件名稱前面加 -,比如:

"plugins": [
    "-search"
]

如果要配置使用的插件可以在 book.json 文件中加入即可,比如我們添加 plugin-github,我們在 book.json 中加入配置如下即可:

{
    "plugins": [ "github" ],
    "pluginsConfig": {
        "github": {
            "url": "https://github.com/13469940053/Web_notes"
        }
    }
}

然后在終端輸入 gitbook install ./ 即可。

如果要指定插件的版本可以使用 plugin@0.3.1,因為一些插件可能不會隨着 GitBook 版本的升級而升級。

五、用 Git 做版本管理

在遠端建好git倉庫,在 mybook 目錄下執行 git init 初始化倉庫,執行 git remote add 添加遠程倉庫。接着就可以愉快地 commit,push,pull …

六、GitBook 簡明教程

http://www.chengweiyang.cn/gitbook/index.html


免責聲明!

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



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