开源必备：
文档、测试用例

在写文档之前，还需要准备其他的工具。定位到项目目录下，npm i gitbook-cli -g 安装 gitbook ，然后创建 SUMMARY.md

运行 gitbook init ，会看到各个文件都被创建了，就可以完善各个文档的内容。内容完成之后，运行 gitbook build 可以将 md 文件发布为 html 文件，默认放在 _book 文件夹。启动了 npm run example 之后，可以访问 http://127.0.0.1:8880/_book/ 查看效果。
修改一下 .gitignore 文件，加上一行 _book ，把打包出来的文件忽略掉。

一、文档和测试用例

1、程序、数据、文档是软件三要素。

二、npm install gitbook-cli -g

1、创建SUMMARY.md

2、（1）项目介绍：README.md

（2）使用文档：doc/use/README.md

（3）二次开发：doc/dev/README.md

3、gitbook init

三、终端输入git status可以找到这个git 文件所含的内容，即不包括.gitignore里的内容。