gitbook的操作使用总结

最新推荐文章于 2021-12-09 16:40:09 发布

原创最新推荐文章于 2021-12-09 16:40:09 发布 · 4k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#gitbook #nodejs #git版本控制管理

gitbook 专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍如何使用GitBook进行文档编写，包括环境配置、编辑排版语法等，还介绍了如何使用Git进行代码协作。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一，环境配置

1，node安装

打开nodejs官网：https://nodejs.org/en/

下载稳定版本(LTS)的node，下载完成之后通过如下命令检查：

node -v   // 检查node的版本，由于nodejsy已经集成了npm，所以安装了node，npm也一并安装好啦

npm -v    // 检查npm的版本

这里写图片描述

2，gitbook-cli安装

npm install gitbook-cli -g  //mac && windows

安装完成之后检查是否成功：

gitbook -V  // 注意V为大写，不识别小写v

如下命令行里显示版本号，则表示安装成功

这里写图片描述

3，git（协作开发使用git请安装，个人开发视需要安装）

git安装具体视用户需要来操作（使用git命令上传代码到github上，需安装git)，具体安装上网搜索。

这里介绍使用git上传代码到github上的操作步骤：

// 第一次上传
git init
git add .
git commit -m "first commit"
git remote add origin https://github.com/myproject/XX-XXXX.git
git push -u origin master

// 第一次上传后的修改及以后上传的操作
git pull  //先更新
git add .
git commit -m "修改 commit"
git remote add origin https://github.com/myproject/XX-XXXX.git
git push -u origin master

删除.git(上传记录)

rm -rf .git

二，常用编辑排版语法

说明：本文采用Markdown语法，以下为常用的MarkDown语法,本文主要包含以下内容：

标题
锚点
链接
图片
缩进
表格
代码块
引用文字
文字颜色
文字居中
HTML标签内联style

1，标题

要创建标题，请在标题之前加1-6个”#”，使用#的多少决定字体的大小；

标题（2个#号）

## 标题（2个#号）

标题（4个#号）

#### 标题（4个#号）

2，锚点

(1)，跳转到本文标题

语法如下：

[跳转到本文标题](#title)  //需要给标题添加id，<span id='title'></span>

(2)，包含字母的一律用小写，包含空格的一律用“-”号

回到顶部Foreign Calling
语法如下：

[回到顶部Foreign Calling](#回到顶部foreign-calling)

(3)，跳转到简介页面

[跳转到简介页面](README.md)  // 跳转到其它的页面的某个位置后加#id “[跳转到简介页面](README.md#id)”

3，链接

(1)，百度

[百度](http://www.baidu.com "百度")  // 鼠标移入显现title属性

(2)，百度

[百度](http://www.baidu.com)    // 无title属性

(3)，自动转换 http://www.baidu.com

<http://www.baidu.com>  // 自动转换为<a href="http://www.baidu.com">http://www.baidu.com</a>

4，图片

(1)，不支持修改图片大小的语法：

![孙悟空](assets/monkey-wk.jpg)

(2)，支持修改图片大小，下图所示代码为：

<img src='assets/monkey-wk.jpg' width='200' alt='孙悟空' title='大师兄'>
或
<img src='assets/monkey-wk.jpg' style='width:150px;' alt='孙悟空' title='二师兄'>

大师兄

5，缩进

(1)，把输入法由半角改为全角。两次空格之后就能够有两个汉字的缩进。

(2)，在开头的时候，先输入下面的代码，然后紧跟着输入文本即可。分号也不要掉。

&ensp;    //半方大的空白
&#8194;   //半方大的空白

&#8195;   //全方大的空白
&emsp;    //全方大的空白

&nbsp;    //不断行的空白格
&#160     //不断行的空白格

6，表格

序号	区域	价格
11	杭州	$1600
22	上海	$12
13	北京	$1
14	广州	$123

上表格语法如下：

|  序号  | 区域    | 价格 |
|:------:|:------:|:---:|
| 11     | 杭州 | $1600 |
| 22     | 上海 |   $12 |
| 13     | 北京 |   $1  |
| 14     | 广州 |  $123 |

序号	种类	价格
1	香蕉	$1600
2	苹果	$212
3	榴莲	$421
4	荔枝	$123

上表格语法如下：

|  序号  | 种类 |  价格 |
| ----- | ----| ---- |
| 1     | 香蕉 | $1600 |
| 2     | 苹果 |  $212 |
| 3     | 榴莲 |  $421 |
| 4     | 荔枝 |  $123 |

7，代码块

  <div>代码块</div>

以上的语法为:

<code><</code>div<code>></code>代码块<code><</code>/div<code>></code>

8，引用文字

(1)，一级段落

一级段落

语法：

 > 一级段落

(2)，二级段落

二级段落

语法：

 >> 二级段落

(3)，三级段落

三级段落

语法：

 >>> 三级段落

9，文字颜色

蓝色字体

语法：

<font color=blue>蓝色字体</font>

10，文字居中

文字居中

语法：

<center>文字居中</center>
或
<center>文字居中<center>

11，HTML标签内联style

eg:

Welcome

语法如下:

<div style='display:inline-block;padding:4px 8px;font-size:20px;font-weight:700;border:3px solid green;border-radius:8px;'>Welcome</div>

三，插件配置

1，在book.json中添加插件配置

"plugins": [
        "-lunr",
        "splitter",
        "-search",
        "search-plus",
        "prism",
        "-highlight",
        "back-to-top-button",//回到顶部
        "expandable-chapters"
      ]

2，通gitbook install命令来安装插件

3，gitbook使用的插件来源于Gitbook-Plugins

4，md文件里面的内容追求少而精，再写书的过程中，对于多章节的内容，尽量编写在多个md，图片小的话可以采用base64格式，但对于大的图片还是采用引用图片的语法（base64图片源码比较占行数，会影响编译）；

5，编译可通过gitbook serve和gitbook build来生产编译好的html于_book(默认)文件夹里。然后可以发布在自己的服务器里，便于管理和访问；同时，可以修改 _book文件里面的style.css来修改样式。发布在gitbook的服务器上，托管在外网上，访问速度都比较慢。

四，结尾

说明：更多排版编辑语法请自行上网搜索

参考文档

gitbook官方帮助文档： https://help.gitbook.com/

gitbook官方工具链文档：https://toolchain.gitbook.com/

gitbook插件官网：https://plugins.gitbook.com/

注意事项:

当单个md文件比较大时，需要拆分为两个或多个以上md，才可以通过如下命令：


gitbook serve   //编译启动node服务

编译跑起来；不然会报错v8。