gitbook使用
1.1 gitbook介紹
1、gitbook說明
GitBook 使用的markdown語(yǔ)法 在此基礎(chǔ)上做了一些 寫作便利性的加強(qiáng)
Markdown 是一種輕量級(jí)的「標(biāo)記語(yǔ)言」，優(yōu)點(diǎn)在于
專注你的文字內(nèi)容而不是排版樣式。
輕松的導(dǎo)出 HTML、PDF 和本身的 .md 文件。
純文本內(nèi)容，兼容所有的文本編輯器與字處理軟件。
可讀，直觀。適合所有人的寫作語(yǔ)言。
2、安裝gitbook
npm install gitbook-cli -g # 安裝gitbook gitbook help # 查看gitbook幫助信息 gitbook -V # 查看gitbook版本信息
3、創(chuàng)建一個(gè)gitbook項(xiàng)目
C:Users om> cd C:aa est-book # 進(jìn)入要進(jìn)行書寫的空文件夾 C:aa est-book> gitbook init # 初始化文件夾 C:aa est-book> gitbook serve --port 80 # 在本地80端口運(yùn)行g(shù)itbook這個(gè)服務(wù) # 注訪問：http://localhost:80
4、設(shè)置gitbook樣式
{
"language": "zh-hans",
"plugins": [
"livereload",
"highlight",
"search",
"lunr",
"-sharing",
"fontsettings",
"theme-default"
],
"styles": {
"website": "styles/website.css"
}
}
book.json ：在C:aa est-book中創(chuàng)建插件配置
.gitbook-link {
display: none!important;
}
styles/website.css ：在C:aa est-book清除默認(rèn)鏈接樣式
1.2 設(shè)置目錄層級(jí)結(jié)構(gòu)
1、說明
1.test-book 目錄下的 SUMMARY.md 文件是 gitbook init 自動(dòng)生成的 你也可以自己創(chuàng)建 這個(gè)markdown文件決定了你文檔的目錄結(jié)構(gòu)
2.SUMMARY.md 就是一個(gè)markdown文件 當(dāng)中內(nèi)容遵循如下格式，星號(hào) 空格 方括號(hào) 圓括號(hào)【* [前言](README.md)】
1）星號(hào)：的縮進(jìn)代表所在條目的層級(jí)結(jié)構(gòu)，四個(gè)空格為一個(gè)層級(jí)，相當(dāng)于是一個(gè)鏈接
2）方括號(hào)：中是鏈接的名字
3）圓括號(hào)：中是一個(gè)文件里面是實(shí)際內(nèi)容
4）默認(rèn)的 README.md 是你的說明文件 你可以將文檔的說明內(nèi)容 在此文件中編輯 對(duì)應(yīng)一本書的前言 或者是序言
2、使用舉例
1）創(chuàng)建對(duì)應(yīng)的文件目錄結(jié)構(gòu)
cd /c/aa/test-book # 在windows中使用git進(jìn)入test-book文件夾，并使用linux環(huán)境
mkdir -p chapter{1,2,3} # 在test-book中創(chuàng)建文件夾：chapter1 chapter2 chapter3
touch chapter{1,2,3}/chapter{1,2,3}.md # 在對(duì)應(yīng)文件夾中創(chuàng)建章節(jié)文件：chapter1.md chapter2.md chapter3.md
touch chapter{1,2,3}/section{1,2,3}.md # 在對(duì)應(yīng)文件夾中創(chuàng)建文章文件：section1.md section2.md section3.md
C:aa est-book>tree /F C:. │ book.json # 設(shè)置gitbook插件 │ README.md # gitbook介紹 │ SUMMARY.md # gitbook目錄結(jié)構(gòu) │ ├─styles │ website.css # 設(shè)置樣式 │ ├─chapter1 # 第一章文件夾 │ chapter1.md # 第一章文件 │ section1.md │ section2.md │ section3.md │ ├─chapter2 # 第二章文件夾 │ chapter2.md # 第二章文件 │ section1.md │ section2.md │ section3.md │ ├─chapter3 # 第三章文件夾 │ chapter3.md # 第三章文件 │ section1.md │ section2.md │ section3.md
創(chuàng)建后的目錄結(jié)構(gòu)如下
2）在test-book/summary.md 中加入目錄結(jié)構(gòu)
# Summary
* [前言](README.md)
* [第一章](chapter1/chapter1.md)
* [第1節(jié)](chapter1/section1.md)
* [第2節(jié)](chapter1/section2.md)
* [第3節(jié)](chapter1/section3.md)
* [第二章](chapter2/chapter2.md)
* [第1節(jié)](chapter2/section1.md)
* [第2節(jié)](chapter2/section2.md)
* [第3節(jié)](chapter2/section3.md)
* [第三章](chapter3/chapter3.md)
* [第1節(jié)](chapter3/section1.md)
* [第2節(jié)](chapter3/section2.md)
* [第3節(jié)](chapter3/section3.md)
* [總結(jié)](summary.md)
summary.md
1.3 gitbook一些實(shí)用插件
1、gitbook中常用插件注釋
參考博客：https://segmentfault.com/a/1190000019806829?utm_source=tag-newest
{
"plugins": [
"splitter", # splitter 側(cè)邊欄寬度可調(diào)節(jié)
"copy-code-button", # 快速?gòu)?fù)制按鈕
"highlight", # 代碼高亮
"accordion", # 折疊模塊(頁(yè)面內(nèi)容可折疊)
"back-to-top-button", # 回到頂部按鈕
"search-pro", # search-pro支持中文搜索，在使用此插件之前，需要將默認(rèn)的search和lunr 插件去掉
"-search",
"-lunr",
"chapter-fold", # 左側(cè)目錄可折疊
"expandable-chapters", # 也是左側(cè)目錄折疊的插件，不同的是可以解決chapter-fold插件的bug
"-expandable-chapters-small", # 也是折疊菜單的，但是這個(gè)插件跟chapter-fold有一樣的bug
"fontsettings",
"livereload", # 為GitBook實(shí)時(shí)重新加載
"popup", # 打開新的頁(yè)面查看圖片
"-sharing", # 去掉左右分享功能
"theme-default",
"theme-comscore", # 主題插件，修改標(biāo)題和表格顏色
"page-treeview" # 在頁(yè)面頂部顯示目錄
],
"styles": {
"website": "styles/website.css"
}
}
{
"plugins": [
"-search",
"-sharing",
"theme-default",
"-lunr",
"fontsettings",
"livereload",
"popup",
"splitter",
"copy-code-button",
"highlight",
"-expandable-chapters-small",
"chapter-fold",
"back-to-top-button",
"search-pro",
"-expandable-chapters"
],
"styles": {
"website": "styles/website.css"
}
}
test-book/book.json : 添加插件
1.gitbook install# 添加的插件沒有，需要安裝（這個(gè)插件比較多，安裝有些耗時(shí)）
2. gitbook serve --port 80 # 重新運(yùn)行項(xiàng)目
2、折疊模塊(頁(yè)面內(nèi)容可折疊)
# 在book.json的plugins參數(shù)中添加插件名
{
"plugins": ["accordion"]
}
%accordion% 折疊代碼塊標(biāo)題 %accordion%
```python
print("折疊代碼塊內(nèi)容")
```
%/accordion%
折疊模塊
3、生成頁(yè)內(nèi)目錄（在book.json的plugins參數(shù)中添加插件名）
{
"plugins": ["page-treeview"],
"pluginsConfig": {
"page-treeview": {
"copyright": "Copyright © aleen42",
"minHeaderCount": "2",
"minHeaderDeep": "2"
}
}
}
生成頁(yè)內(nèi)目錄：page-treeview
4、gitbook代碼高亮
{
"plugins": [
"prism",
"prism-themes"
],
"pluginsConfig": {
"prism": {
"css": ["prism-themes/themes/prism-duotone-dark.css"]
}
}
}
代碼高亮：prism
1.4 把gitbook打包
1、gitbook打包
C:Users om> cd C:aa est-book # 進(jìn)入gitbook文件目錄 C:aa est-book> gitbook build # 把文件編譯成html格式
2、由于gitbook 3.x.x版本bug導(dǎo)致build后的文件無法自動(dòng)跳轉(zhuǎn)頁(yè)面
# 文件位置：_bookgitbook heme.js # 由于代碼是壓縮后的，會(huì)沒有空格，搜索的時(shí)候可以直接搜索： if(m)for(n.handler&& # 將if(m)改成if(false)
總結(jié)
- 上一篇： JS登录加密算法破解
- 下一篇： 函数的定义域