使用 GitBook 完成你的写作

最新推荐文章于 2024-03-17 20:10:21 发布

Beyonderwei

最新推荐文章于 2024-03-17 20:10:21 发布

阅读量445

点赞数

分类专栏： GitBook 文章标签： GitBook github git

本文为博主原创文章，未经博主允许不得转载。

本文链接：https://blog.csdn.net/csdn_x_w/article/details/103985329

版权

GitBook 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

文章目录

一、什么是GitBook

Document everything for you,your users and your team.
GitBook并不是Git的教程，而是以Git作为版本控制系统，结合Github、Markdown用来写书（文档等）的工具。你可以在GitBook的网站、计算机本地上进行你的创作，GitBook帮你制作出精美的电子书籍，同时GitBook的网站对于写作和协同创作都有较好的支持。

二、GitBook特点

凭借这个平台可以创建精美的个人笔记、说明文档、甚至是写书等…
Markdown书写，简单方便
多地同步： 文档与GitHub仓库绑定，本地创作Push到Github后可自动同步到GitBook并展示，在GitBook上创作后可一键提交到Github仓库。
可输出各种格式化文档，包括PDF、HTML、eBook等
缺点： GitBook网页创作及查看书籍目前需要XXX才可以使用。
…

三、开始使用

前提： 默认你是拥有Git和Github的使用经验的

在Github上创建一个仓库，并克隆到本地
注册登录GitBook（通过Github账号登录，方便后期绑定仓库），创建一个新的Space
进入到创建好的Book中，在左侧intergrations开启Github并绑定之前创建好的仓库
因为GitBook是基于Node.js的工具，因此需要在计算机本地安装Node.js，可以在 nodejs官网下载并傻瓜式安装，安装完成后可以在命令行通过 node -v 和 npm -v 查看版本号
在本地安装GitBook脚手架：npm install gitbook-cli -g 通过 gitbook -V 查看gitbook和CLI的版本。
在之前拉取的仓库目录下执行 gitbook init 来初始化书籍，这时由于已经有了原有仓库的README.dm 因此GitBook自带的README.md便不会再生成。成功后会包含如下三个文件夹：

注：_book为自动生成的文件，SUMMARY.md为书籍的目录文件，这个需要按照一定格式来书写，很简单，以下分别表示一级、二级…目录，以此类推。括号内为与之绑定要显示的内容的文件
运行 gitbook serve 即可在本地运行项目，并可以通过访问http://localhost：4000 查看效果。
最后add commit push 项目到github 仓库，这时由于GitBook已经绑定了该仓库，因此，访问GitBook即可查看到最新的书籍状态。