程序员的资源宝库

网站首页 > gitee 正文

gitbook使用入门

sanyeah 2024-04-09 20:02:14 gitee 5 ℃ 0 评论

GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书。GitBook支持输出以下几种文档格式

  • 静态站点:GitBook默认输出该种格式

  • PDF:需要安装gitbook-pdf依赖

  • eBook:需要安装ebook-convert

新接触的时候要大概理解这个软件的意义,是基于git的分布式文本编辑。一个组织中的多个人,合作写一个文本,大家都可以使用独立的分支,可以分开可以合并,大家都是master也都是origin; 

1 先行安装Node.js、GitBook、GitBook Editor、Git版本控制器

node -v //显示v4.5.0 验证是否安装成功;

npm install gitbook -g 命令行安装gitbook;

npm install -g gitbook-cli 安装gitbook的命令行工具;

gitbook -V //显示0.4.2 检测是否成功;

卸载用npm uninstall -g gitbook

 

下载安装gitbook editor 我这儿用的mac,安装后使用;

我的实际情况时,公司在用gitlab,产品团队一起编辑产品文档,就需要拉下gitlab上的书,然后本地编辑,上传后由管理员合并文档;

拉下数据;初次可以直接下载 ;打开gitbook editor import 本地的书;

 

gitbook中书的删除,这点困扰我很久,吐槽,新手肯定会新建书做测试,有洁癖的我非删了ta不可。删除很简单,在dashboard里,书的后面,setting,在最后面有个delete;

- 现在开始,实际说明使用,因为我们装了客户cli,就拿cli来讲,比较炫酷,其实也很方便;

第一个命令:gitbook init mybook  初始化一本书,名字叫 mybook;(更多命令可看 gitbook helo,统共8个,不要虚);

这时候就见

warn: no summary file in this book 

info: create README.md 

info: create SUMMARY.md 

info: initialization is finished

因为本来没这本书的,所以新建了 readme.md (封面)、summary.md(目录);

接着我们就可以开始编辑书的内容了;

如何编写:

gb的文档规范为markdown语法,非常简单,不赘述,可以看 http://www.appinn.com/markdown/  个人使用感觉,如果用太麻烦的语法,就失去了意义,还不如直接拿word方便。

编写完成后,适用 gitbook serve $bookname ,然后就能在localhost:4000里查看了。

Tags:

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表