Mac GitBook安裝和使用
安裝
- 安裝npm
從網(wǎng)站 https://nodejs.org/en/#download下載node.pkg文件安裝即可。
// 檢查npm是否安裝成功
npm -v
// 檢查node是否存在
node -v
- 安裝GitBook
Gitbook是在npm環(huán)境下安裝的班套,所以前提得先安裝好npm衙伶。
// 安裝Gitbook命令
sudo npm install -g gitbook-cli
// 檢查是否安裝成功
gitbook -v
- 安裝Gitbook Editor客戶端
官網(wǎng)下載地址:https://www.gitbook.com/editor
用它輔助寫文檔很好用,可以登錄從GitBook下載Book進行修改提交(我試過直接https進行拉取出錯,后來直接云端下載同步到本地才能進行push操作)
不過沒有生成靜態(tài)Html(_book那個文件夾)供鸠,還需cd 命令進入book所在文件使用gitbook build這條命令進行生成弊攘。
不過Gitbook網(wǎng)站里支持閱讀和下載。
- 注意事項
- 不能使用 npm install gitbook -g 命令安裝婆硬,因為使用命令gitbook的時候會出現(xiàn)問題。
- 安裝的命令前需要加入sudo,因為可能會找不到npm的 /usr/local/bin/路徑奸例。
- 使用gitbook -v命令檢查時可能會不出現(xiàn)版本號彬犯,但其實是安裝好了。
使用
MarkDown語法
Markdown 是一種「電子郵件」風格的「標記語言」,Gitbook就是采用這種語言規(guī)范來編輯查吊。
- 標題
# 一級標題(H1)
## 二級標題(H2)
### 三級標題(H3)
...依次類推
- 注:# 和「一級標題」之間建議保留一個字符的空格谐区,這是最標準的 Markdown 寫法。
- 列表
*,+,-符號的作用一樣逻卖,都是表示無序列表
列表格式在MarkDown中比較常見
// - 和文本之間有空格
- 文本1
- 文本2
- 文本3
如果希望有序列
1.文本
2.文本
3.文本
- 插入鏈接和圖片
// 文本鏈接
[顯示文本](鏈接地址)
// 圖片鏈接
/**! [](圖片鏈接地址):注意不能中間有空格宋列,我這里因為簡書原因,連代碼塊區(qū)域都檢查圖片*/
- 引用
// > 和文本之間有空格
> 文本
- 粗體和斜體
1.斜體表示:*文本*
2.粗體表示:**文本**
- 表格
// 每列使用“|”隔開评也,每行標題和內(nèi)容使用“| ----- |”隔開
1. 默認靠左對齊: | ----- |
2. 靠右對齊:| -----: |
3. 居中顯示:| :-----: |
| Table1 | Table2 | Table3 |
| ------ |:------:| ------:|
| 靠左 | 居中 | 靠右 |
| 靠左 | 居中 | 靠右 |
| 靠左 | 居中 | 靠右 |
預(yù)覽
Table1 | Table2 | Table3 |
---|---|---|
靠左 | 居中 | 靠右 |
靠左 | 居中 | 靠右 |
靠左 | 居中 | 靠右 |
- 代碼塊區(qū)域(陰影區(qū))
```中間換行 ```表示
- 分割線
三個以上的*或者-符號表示