概述
最近需要写一些文档。我也经常使用markdown,但是使用gitbook来编写一份文档,没有做过,现在写一篇文章专门记录中间一些自己不清楚的点。
环境搭建
使用的node.js版本为:10.24.1。
使用的gitbook版本为: ^2.3.2。
gitbook版本太高了之后,需要使用他们云编辑工具,可能还需要收费,所以我们使用低版本也足够使用了。
初始化
导航
在根目录中有个 SUMMARY.md 文件,里面指定了目录中的 md 文件。这样就会在导航中出现。
图片引入
在根目录里面创建一个 assets/image/ 目录,将图片都放入其中。在 markdown 文件中就能通过指定文件就能显示图片了。
工具
可能涉及到将一些API从swagger文档中直接导出成文本,可以使用网上的工具来做。