为自己的成果写一本GITBOOK

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

REDUX 应用框架ZORO是我第一个开源项目,我为此感到欣慰,因为这也是我一直想要去做的事情,或多或少的为开源社区做贡献

重该项目第一次提交


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

到现在2.*版本


image.png

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

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

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

下载地址: NODEJS官网,下载LTS版本的,直接安装即可
下载地址: GIT下载地址 下载完成直接安装即可

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

$ npm install -g gitbook-cli

接下来初始化我们的书籍

$ mkdir book
$ cd ./book
$ gitbook init

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

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

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

下载地址: 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

之后通过浏览器访问http://localhost:4000即可查看,
该命令同时也具备build命令的功能,会在book目录下生成_book目录

最后一起看看我完成的gitbook书吧https://faurewu.github.io/zoro/

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

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 概述 GitBook 是使用 GitHub / Git 和 Markdown(或AsciiDoc)构建漂亮书籍的命...
    辉这样说阅读 8,175评论 0 4
  • 本文详细讲解了 Gitbook 生成电子书的完整过程,内容包括:安装、命令、配置、文档结构、生成电子书、部署。限于...
    静默虚空阅读 13,881评论 9 138
  • 最近遇到一些问题,就是团队中会有些伙伴踩得坑的收集问题或者有些较为复杂的业务需求文档共享上成本较高,所以考虑弄...
    tobAlier阅读 9,382评论 0 5
  • 转载请注明出处,谢谢 初级(适合没有编程基础的童鞋看) 使用GitBook Editor 写开源书籍 这个是git...
    全科阅读 15,122评论 25 110
  • 有人说我总是一副冷冰冰的表情,不爱笑。我的朋友对我的第一印象大多是这个人太高冷,不易亲近,但熟悉之后就会一副神经病...
    倾池凝芷阅读 4,172评论 0 0

友情链接更多精彩内容