使用Gitbook作筆記

1、安裝

https://github.com/GitbookIO/gitbook/blob/master/docs/setup.mdhtml

# 經過npm全局安裝
npm install gitbook-cli -g

# 查看版本
gitbook --version

2、建立一本書

2.1 本地建立

# 建立一個文件夾
mkdir mysql-note

# 初始化
cd mysql-note
gitbook init
# 會建立兩個文件
# README.md  書皮
# SUMMARY.md 目錄

# 從本地打開這本書
gitbook serve
# 將md文件編譯成html文件並輸出到_book目錄下

能夠本地訪問:http://localhost:4000node

2.2 備份到github

# 從github上建立一個名爲mysql-note的倉庫

# 將mysql-note這個目錄初始化爲一個git倉庫
git init

# 建立.gitignore文件,忽略_book文件
vi .gitignore
# 追加
_book/

# 提交
git commit -m "first commit"

# 關聯github上建立的庫
git remote add origin git@github.com:clzbgl/mysql-note.git

# 推送到遠程庫
git push -u origin master

2.3 經過網絡訪問這本書

2.3.1 調整目錄結構

# 調整目錄結構
mkdir content
mv *.md content/
mv git content/

調整前mysql

調整後git

2.3.2 變成node項目

# 將當前項目變成node項目
npm init
# 一路回車,生成package.json文件

package.jsongithub

2.3.3 配置腳本

將下面這段腳本複製到package.json中相應位置sql

"scripts": {
 "start": "gitbook serve ./content ./gh-pages",
 "build": "gitbook build ./content ./gh-pages",
 "deploy": "node ./scripts/deploy-gh-pages.js",
 "publish": "npm run build && npm run deploy",
 "port": "lsof -i :35729"
},

2.3.4 啓動命令start

# 啓動,調用npm腳本
npm run start

# 修改.gitignore,將gh-pages和node_modules加入到忽略
gh-pages
node_modules

2.3.5 編譯命令build

# 啓用build
npm run build

2.3.6 部署命令deploy

建立發佈腳本 scripts/deploy-gh-pages.jsshell

'use strict';
var ghpages = require('gh-pages');
main();
function main() {
    ghpages.publish('./gh-pages', console.error.bind(console));
}

關於這段腳本npm

# gh-pages的publish方法,建立gh-pages分支,將修改拷貝到gh-pages分支而且上傳到github

# 安裝gh-pages這個包
npm install --save gh-pages

2.3.7 發佈命令publish

執行發佈命令json

# 執行發佈命令,就是先執行編譯再執行部署
npm run publish
# 輸入undefined表示成功

訪問 https://clzbgl.github.io/mysql-note/網絡

2.4 放一張圖片

圖片放到content/img/目錄下

執行一下發布命令,就可能經過網絡看到效果了。

3、參考

  • 官網:https://github.com/GitbookIO/gitbook

  • 參考:http://haoduoshipin.com/videos/231

相關文章
相關標籤/搜索