Gitbook最全初始配置

2022-06-06 10:27:10 字數 3687 閱讀 1156

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

npm install gitbook-cli -g

gitbook init

readme.md —— 書籍的介紹寫在這個檔案裡

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)

執行gitbook serve來預覽這本書籍,執行命令後會對 markdown 格式的文件進行轉換,預設轉換為 html 格式,最後提示 「serving book on http://localhost:4000」

[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 進行匯出。

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

gitbook init //初始化目錄檔案

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

gitbook --help //輸出gitbook-cli的幫助資訊

gitbook build //生成靜態網頁

gitbook serve //生成靜態網頁並執行伺服器

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 檔案。

該檔案主要用來存放配置資訊,我先放出我的配置檔案。

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

title

本書標題

author

本書作者

description

本書描述

language

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

gitbook

指定使用的 gitbook 版本

styles

自定義頁面樣式

structure

指定 readme、summary、glossary 和 languages 對應的檔名

links

在左側導航欄新增鏈結資訊

plugins

配置使用的外掛程式

pluginsconfig

配置外掛程式的屬性

這個檔案主要決定 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 中加入配置如下即可:

}}

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

如果要指定外掛程式的版本可以使用 [email protected],因為一些外掛程式可能不會隨著 gitbook 版本的公升級而公升級。

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

webpack打包配置最全!!!!!!

建立列表隔行變色專案 新建專案空白目錄,並執行 npm init y 命令,初始化包管理配置檔案 package.json 新建 src 源 目錄 新建 src index.html 首頁 初始化首頁基本的結構 執行 npm install jquery s 命令,安裝 jquery 通過模組化的形...

django初始配置

首先安裝django pip install django我使用的是anaconda環境 conda install django開始建立 hello專案 hello是專案名稱 django admin startproject hello hello hello init.py settings....

git 初始配置

使用者名稱和郵箱 git config global user.name your name git config global user.email you your.domain 配置換行符 windows下建議 git config global core.autocrlf true 這將使檔...