简单易用的文档工具 - docbox

在做开发的时候,不可避免的需要写很多技术文档。目前大家都比较喜欢的方式是使用Markdown,但用markdown写完之后,怎样才能以漂亮,专业的方式进行展示呢?下面介绍的docbox就是这样一个工具。

其实,docbox有点像一些流行的静态站点生成器,比如:Hexo, Gatsby等。这不过,它的作用更加专注:专门针对软件开发文档进行的设计。

安装方式非常简单,只需要运行如下命令:

1
2
3
4
git clone https://github.com/tmcw/docbox.git 
cd docbox
npm install
npm start

然后在浏览器中打开:http://localhost:9966

就可以看到如下的界面:

image

在页面中,左边是对应的API列表,中间是当前API的描述,右边则是样例,非常的直观。

如果在VS Code中打开docbox这个目录,还能看到它其实就是一个标准的React项目:

image

如果想要编写自己的文档,只需要在content目录中放置自己的markdown文件就可以了。如果在生产环境中,还可以使用docbox来生成静态的html页面,这点和普通的React应用完全一样。

当然,如果需要的话,也可以自己来定制API文档的样式,这就和在React中使用自定义样式一样。

评论