Typera+Node.js+Git搭建托管于远端的写作平台（GitBook）

谁借莪１个温暖的怀抱￠ 2021-09-23 22:40 184阅读 0赞

### 文章目录 ###

*  0x00 文章内容
 *  0x01 环境准备
 *   *   *   *   *  1. Typera
                 *  2. Node.js
                 *  3. Git
 *  0x02 GitBook闪亮登场
 *   *   *   *   *  1. 安装GitBook
                 *  2. 初始化GitBook
                 *  3. 生产GitBook目录结构
                 *  4. 启动GitBook服务
                 *  5. 构建GitBook书籍
 *  0x03 与Git完美配合
 *   *   *   *   *  1. 提交文档到码云
 *  0xFF 总结

# 0x00 文章内容 #

1.  环境准备
2.  GitBook闪亮登场

一直在寻找一个比较良好的MarkDown写作平台，几乎把市面上所有的产品都试过了，但还是决定这样解决，原因如下：

1.  Typera是一个非常不错的MarkDown编辑器，但是复制到它上面的图片只能存放在本地，无法同步到云端，如果需要将你的MarkDown文本复制到其他平台，则需要将图片一一复制一遍，过程非常繁琐。
2.  想要一个随时随地都可以远程开发的环境

主要的问题就是：真的有点复杂！

# 0x01 环境准备 #

##### 1. Typera #####

a. 下载与安装（=> [链接跳转][Link 1]）  
b. 配置，因为要配置到Git，所以准备将图片配置成保存在assets文件夹，这样比较方便以后利用  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70]

##### 2. Node.js #####

a. 请参考文章：

*  [Node版本管理工具nvm的安装与使用（windows）][Node_nvm_windows]

##### 3. Git #####

a. Git的安装与配置（Mac版本）=> [链接跳转][Link 2]

# 0x02 GitBook闪亮登场 #

##### 1. 安装GitBook #####

a. 全局安装GitBook（可以去看一下目录里有没有下载到东西）  
`npm install -g gitbook-cli`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 1]

解释：Node.js默认安装了npm（node包管理工具），此处不用单独安装npm，执行以下命令安装GitBook。

##### 2. 初始化GitBook #####

a. 新建一个文件夹，作为一本笔记本的主目录，之后将会有一篇又一篇的文章，此处我的文件夹为：`test-book`  
`mkdir test-book`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 2]  
b. 接着初始化GitBook，进入`test-book`文件夹，执行：  
`gitbook init`  
![在这里插入图片描述][20200217182646437.png]  
**遇到问题**：此时可能会遇到问题，一直卡在这里。

**需要注意的点**：

1.  注意cmd命令行要使用“管理员身份打开”，提升其管理员权限。  
    ![在这里插入图片描述][20200217184742915.png]
2.  查资料说版本问题，于是我卸载了默认的3.2.3的版本：  
    `gitbook uninstall 3.2.3`  
    如果提示不需要卸载，则不管。  
    下载一个3.0.0版本：  
    `gitbook fetch 3.0.0`  
    ![在这里插入图片描述][20200217190006903.png]  
    等了几分钟之后，就提示安装完成了，此时再重新初始化就可以了：  
    `gitbook init`  
    ![在这里插入图片描述][20200217190101401.png]  
    解释：完成后，`test-book`文件夹下会多了两个文件 =>  
    `README.md`：书籍的介绍可写在此文件中  
    `SUMMARY.md`：书籍的目录结构可写在此文件中  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 3]

##### 3. 生产GitBook目录结构 #####

a. 编辑`SUMMARY.md`文件，此时就可以使用Typora了，将内容修改为：

# 目录
    
    * [前言](README.md)
    * [第一章 全栈工程师之路](全栈工程师之路/README.md)
      * [第1节 前端](全栈工程师之路/前端.md)
      * [第2节 后端](全栈工程师之路/后端.md)
      * [第3节 运维](全栈工程师之路/运维.md)
      * [第4节 UI设计](全栈工程师之路/UI设计.md)
    * [第二章 大数据](大数据/README.md)
    * [第三章 云计算](云计算/README.md)
    * [第四章 人工智能](人工智能/README.md)

b. 接着生成目录结构，在`test-book`文件夹中再次执行命令：  
`gitbook init`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 4]  
c. 返回Typora，发现已经生成了目录结构  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 5]  
解释：`GitBook`会根据`SUMMARY.md`文件中描述的目录和文件生成目录结构，文件也会生成，如果之前没有创建的话。

##### 4. 启动GitBook服务 #####

a. 启动预览服务  
`gitbook serve`

提示错误：

Error: ENOENT: no such file or directory, stat 'C:\Users\Administrator\Documents\01shao\test-book\_book\gitbook\gitbook-plugin-lunr\lunr.min.js'

问题解决参考：  
[gibook工具常见的问题记录][gibook]

修改下面的问题件`~`指的是用户目录  
`~\.gitbook\versions\3.2.3\lib\output\website\copyPluginAssets.js`中的112行内容  
原始内容 ,主要是confirm的true需要修改为false  
修改后：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 6]  
再重新执行：  
`gitbook serve`  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 7]  
提示`“Serving book on http://localhost:4000”`，即默认是启动在localhost:4000，此时用浏览器打开此url则可看到结果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 8]

##### 5. 构建GitBook书籍 #####

a. 构建书籍  
`gitbook build`

1.  当然也不用经常构建，此步骤其实就是想要打包到其他地方执行了才执行，如果有编程基础的话应该是比较容易理解的。
2.  你可以像发布前端项目一样将我们的项目发布出去。

# 0x03 与Git完美配合 #

##### 1. 提交文档到码云 #####

a. 使用Git将代码提交到码云 => [链接跳转][Link 3]

我们可以将编辑好的文件，上传到云端，实现远端开发，此过程不再累赘，请参考一些Git相关的内容。

# 0xFF 总结 #

1.  其他的操作总结

*  build可以指定书籍的路径以及输出路径：  
    `gitbook build [书籍路径] [输出路径]`
 *  serve 命令也可以指定端口：  
    `gitbook serve --port 4044`
 *  生成不同格式的电子书：  
    `gitbook 格式 [书籍路径] [输出路径]`  
    如：  
    `gitbook pdf ./ ./mybook.pdf`  
    `gitbook epub ./ ./mybook.epub`  
    `gitbook mobi ./ ./mybook.mobi`

1.  最后说句心里话，体验了下后，感觉这东西也没什么用，可能对于目录的结构有那么一点点用，其他的也没什么。

参考文章：

*  [GitBook 从懵逼到入门][GitBook]
 *  [gitbook安装与使用之windows下搭建gitbook平台][gitbook_windows_gitbook]
 *  [记坑爹的服务器端gitbook安装过程-太坑了][gitbook_-]
 *  [gitbook安装中installing gitbook xxx 时间过长的问题][gitbook_installing gitbook xxx]

--------------------

**福利：**  
[邵奈一的技术博客导航][Link 9]  
[邵奈一][CSDN] 原创不易，如转载请标明出处。

--------------------

[Link 1]: https://www.typora.io/#download
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70]: /images/20210923/33aa6992b026419db7f751d07696dffd.png
[Node_nvm_windows]: https://blog.csdn.net/shaock2018/article/details/86717428
[Link 2]: https://blog.csdn.net/shaock2018/article/details/91127607
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 1]: /images/20210923/16406449f67b4dec9848dc4eef8e9663.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 2]: /images/20210923/e255b33e98044720953a0ab3da045444.png
[20200217182646437.png]: /images/20210923/8c298b0951664bffa5f86bbf54d03ecd.png
[20200217184742915.png]: /images/20210923/835e82086cd84adcbaa13156eb5e622f.png
[20200217190006903.png]: /images/20210923/361f2d01318f49c48d4a955bf8ef08c0.png
[20200217190101401.png]: /images/20210923/020d1ad2c641418aa64379a8b9392c08.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 3]: /images/20210923/d20086dad7b947adbced49b1ba27da3e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 4]: /images/20210923/13250fa438e54eb9be6224fb13122873.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 5]: /images/20210923/cd26d609ea184bf997b461ab920b9790.png
[gibook]: https://blog.csdn.net/yinlongfei_love/article/details/84636035
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 6]: /images/20210923/f414939bfd1540b4a9459d585ba896c2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 7]: /images/20210923/28fab2e7ed0d458ca1500efd7404a70d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg_size_16_color_FFFFFF_t_70 8]: /images/20210923/34d2b90fb7c4460e99fa73674d250ac5.png
[Link 3]: https://blog.csdn.net/shaock2018/article/details/91129906?ops_request_misc=%7B%22request%5Fid%22%3A%22158192914819725222458543%22%2C%22scm%22%3A%2220140713.130056874..%22%7D&request_id=158192914819725222458543&biz_id=0&utm_source=distribute.pc_search_result.none-task
[GitBook]: https://blog.csdn.net/lu_embedded/article/details/81100704
[gitbook_windows_gitbook]: https://blog.csdn.net/zerorm/article/details/79229053
[gitbook_-]: http://www.yanjuntech.cn/archives/2396
[gitbook_installing gitbook xxx]: https://blog.csdn.net/qq_39482771/article/details/89436833
[Link 4]: https://blog.csdn.net/shaock2018/article/details/91184254
[Link 5]: https://img-blog.csdnimg.cn/20190608000417972.jpeg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NoYW9jazIwMTg=,size_16,color_FFFFFF,t_70
[Link 6]: https://img-blog.csdnimg.cn/20190514084602748.png
[Link 7]: https://weibo.com/5680168183/
[CSDN]: https://blog.csdn.net/shaock2018
[Link 8]: https://www.jianshu.com/u/6f033c6a3b90
[Link 9]: https://blog.csdn.net/shaock2018/article/details/89349249