搜索
您的当前位置:首页正文

为自己的成果写一本GITBOOK

来源:二三娱乐

贡献开源真的是一种快乐,这与工作不同,我们可以无怨无悔的为解决一个BUG,通宵熬夜,只希望自己写的成果能给他人带来方便,快乐,减少别人的烦恼。

重该项目第一次提交


C04B473A-0A68-4794-9E2D-3F6B18D4C655.png

到现在2.*版本


image.png

已经经历了126个大大小小的commit, 15个版本迭代,不断的在公司实际项目中使用,不断的优化,现在已经趋于稳定,感谢有幸能得到使用者的3十几个star,起初的每一个star都让我倍感兴奋,因为这是一种认可,也是我坚持的动力

今天我想为自己的这个成果写一本书,同时也分享如何使用GITBOOK写书

为了使用gitbook,我们首先安装nodejs, git

nodejs安装完成后,系统就有了npm命令,接下来我们执行命令安装gitbook-cli

$ npm install -g gitbook-cli

接下来初始化我们的书籍

$ mkdir book
$ cd ./book
$ gitbook init

这时我们的book目录下多出来了两个文件

README.md 常用于写书的前言
SUMMARY.md 用于写书的目录

接下来有了书籍,我们还需要一个图形化管理界面,方便我们时时编辑查看内容,这里使用Typora

下载完成打开Typora,并且打开我们的book目录,编写相关的章节即可

以下是我已经写好的ZORO文档

image.png

所有的内容支持markdown语法,同简书一样使用简单易懂

我们如何编写目录呢

image.png

对应的内容如下:

# 目录
* [前言](REDAME.md)
* [安装](INSTALL.md)
* 教程
  * [快速开始](GUIDE/QUIKE_START.md)
  * [接入create-react-app](GUIDE/CREATE_REACT_APP.md)
 ...省略其他内容

当我们完成了书籍编写,我们如何生成一个网站呢,执行如下命令

$ gitbook build

变会在book目录下生成_book目录

如果你想要临时查看生成的网站效果可以执行如下命令

$ gitbook serve

每次写完文章都觉得自己的文笔相当的差,总无法完好表达自己的想法,感谢您的观看

Top