1. 安裝
- 1.1 安裝NodeJs
- 1.2 Gitbook 命令行工具安裝 ,詳情參考 >gitbook 安裝配置官方文檔
npm install gitbook-cli -g
2. 使用
了解下面幾點(diǎn),基本就可以愉快的在本地寫書了
2.1 命令行基本命令使用
- 新建書籍,在目錄中執(zhí)行:
gitbook init - 構(gòu)建預(yù)覽html文件
gitbook build - 開啟服務(wù)在瀏覽其中預(yù)覽
gitbook serve
傳送門:
安裝使用:Setup and Installation of GitBook
- 編輯后提交到Git庫:
git add .
git commit -m "提交備注"
2.2 了解目錄結(jié)構(gòu)
不累述,直接傳送官方說明:
2.3 了解book.json 配置方法
傳送門:
book.json 配置
3. 插件安裝與配置
插件搜索瀏覽: GitBook Plugins
3.1 代碼高亮
1) prism插件
點(diǎn)擊上方鏈接查看如何配置(下同)
3.2 TOC(Table of Content)
1) 頁面內(nèi) - navigator
在標(biāo)題下方顯示目錄
2) 側(cè)邊 - simple-page-toc
- 在右上方顯示一個(gè)TOC 按鈕,點(diǎn)擊后顯示目錄
- 在右上方顯示一個(gè)Top 按鈕,點(diǎn)擊后回到文章頂部
3.4 目前的配置大集合
{
"title": "項(xiàng)目文檔記錄",
"description": "項(xiàng)目文檔記錄",
"language": "zh",
"plugins": [
"prism",
"-highlight",
"simple-page-toc",
"navigator"
],
"pluginsConfig": {
"simple-page-toc": {
"maxDepth": 3,
"skipFirstH1": true
}
}
}
4. 使用文檔編輯器
GitbookEditor
GitBook 官方出品 ,下載鏈接 GitbookEditor,如果不熟悉基本的git命令,那么最好使用這個(gè)
Sublime Text
參考:Windows上使用Sublime編輯markdown并預(yù)覽
另外提下Sublime 有個(gè)Open Folder 功能,可以在左側(cè)顯示目錄樹,更方便的是可以在增加文件目錄,重命名文件目錄
工作流程:
Sublime中修改 -- gitbook serve 預(yù)覽 -- git add . 及git commit -m "msg" 提交 -- git push 推送
5. 編輯(Markdown語法)
傳送:
Markdown
- 代碼高亮
指定代碼語言-添加ruby指定語言為ruby
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html