gitbook安装及使用

GitBook 是一个基于 Node.js 的命令行工具,可使用 Markdown 来制作精美的电子书,并发布到 github 上(需要下载 GitBook Editor 支持),也可手动发布到 gitee.com 上(国内的代码托管平台-码云)。由于官网属于国外网站的,在国内访问的网速并不理想,推荐还是手动发布到 gitee.com 上。

我自己在 gitbook + Typora + gitee + 阿里云ECS服务器 发布了自己的学习笔记,https://doc.798ziyuan.com/

下面言归正传,记录一下 gitbook 的安装:

  • 前置要求

本地必须安装 nodejs、git客户端;另外最好下载一款编辑器,否则不太好编写 markdown 语法的文件,像上面提到的 Typora 的编辑器是不错的 markdown 编辑器,缺点是不支持实时预览,需要手动回车才可以。可以考虑下载下国内的作业部落客户端,不过我也不知道是否免费开放,你可以去试试看。

  • 安装nodejs

Node js 的安装可参考菜鸟教程的 Node.js 安装配置-》https://www.runoob.com/nodejs/nodejs-install-setup.html

  • git 安装

Git 的安装可以参考 廖雪峰的 Git 安装-》https://www.liaoxuefeng.com/wiki/896043488029600/896067074338496

  • gitbook安装

执行如下两条命令,在电脑上安装 gitbook

npm install gitbook -g

npm install -g gitbook-cli

  • 检测安装是否成功

gitbook -V

运行结果显示除版本信息外信息一致,则表示安装成功:$ gitbook -V CLI version: 2.3.2 GitBook version: 3.2.3

  • 如何使用?

安装成功后,找一个空目录,通过 git bash 命令窗口进入到 目录执行 gitbook init。gitbook init 命令运行成功会创建两个文件,README.md SUMMARY.md。

README.md 是可以理解为是介绍文档,可以写一些介绍相关的信息;SUMMARY.md 是 book 的目录结构。

  • 先玩一把看看效果

将 SUMMARY.md  将修改为如下:

# Summary

* [Introduction](README.md)

## 测试

* [测试目录]

* [01-测试1](test/01-test1.md)

* [02-测试2](test/01-test2.md)

运行 gitbook init 初始化对应的文件

运行 gitbook build 创建对应的 html 文件

打开浏览器访问 http://127.0.0.1/loo/_book/ 看效果

 

总结:

  • gitbook init 初始化文件
  • gitbook build 创建对应的html文件
  • gitbook serve 服务化启动文件,默认访问 127.0.0.1:4000 ,可指定端口启动服务
  • gitbook build docs whistle2 是将docs的内容创建到whistle2目录下
  • gitbook help 查看更多命令

 

« »

发表评论

电子邮件地址不会被公开。 必填项已用*标注

昵称 *