Mac GitBook安装和使用
2016-07-03 本文已影响5443人
Pocket
Mac GitBook安装和使用
安装
- 安装npm
从网站 https://nodejs.org/en/#download下载node.pkg文件安装即可。
// 检查npm是否安装成功
npm -v
// 检查node是否存在
node -v
- 安装GitBook
Gitbook是在npm环境下安装的,所以前提得先安装好npm。
// 安装Gitbook命令
sudo npm install -g gitbook-cli
// 检查是否安装成功
gitbook -v
- 安装Gitbook Editor客户端
官网下载地址:https://www.gitbook.com/editor
用它辅助写文档很好用,可以登录从GitBook下载Book进行修改提交(我试过直接https进行拉取出错,后来直接云端下载同步到本地才能进行push操作)
不过没有生成静态Html(_book那个文件夹),还需cd 命令进入book所在文件使用gitbook build这条命令进行生成。
不过Gitbook网站里支持阅读和下载。
- 注意事项
- 不能使用 npm install gitbook -g 命令安装,因为使用命令gitbook的时候会出现问题。
- 安装的命令前需要加入sudo,因为可能会找不到npm的 /usr/local/bin/路径。
- 使用gitbook -v命令检查时可能会不出现版本号,但其实是安装好了。
使用
MarkDown语法
Markdown 是一种「电子邮件」风格的「标记语言」,Gitbook就是采用这种语言规范来编辑。
- 标题
# 一级标题(H1)
## 二级标题(H2)
### 三级标题(H3)
...依次类推
- 注:# 和「一级标题」之间建议保留一个字符的空格,这是最标准的 Markdown 写法。
- 列表
*,+,-符号的作用一样,都是表示无序列表
列表格式在MarkDown中比较常见
// - 和文本之间有空格
- 文本1
- 文本2
- 文本3
如果希望有序列
1.文本
2.文本
3.文本
- 插入链接和图片
// 文本链接
[显示文本](链接地址)
// 图片链接
/**! [](图片链接地址):注意不能中间有空格,我这里因为简书原因,连代码块区域都检查图片*/
- 引用
// > 和文本之间有空格
> 文本
- 粗体和斜体
1.斜体表示:*文本*
2.粗体表示:**文本**
- 表格
// 每列使用“|”隔开,每行标题和内容使用“| ----- |”隔开
1. 默认靠左对齐: | ----- |
2. 靠右对齐:| -----: |
3. 居中显示:| :-----: |
| Table1 | Table2 | Table3 |
| ------ |:------:| ------:|
| 靠左 | 居中 | 靠右 |
| 靠左 | 居中 | 靠右 |
| 靠左 | 居中 | 靠右 |
预览
Table1 | Table2 | Table3 |
---|---|---|
靠左 | 居中 | 靠右 |
靠左 | 居中 | 靠右 |
靠左 | 居中 | 靠右 |
- 代码块区域(阴影区)
```中间换行 ```表示
- 分割线
三个以上的*或者-符号表示