VueDoc - 方便的API或技术文档工具

什么是 VueDoc

VueDoc 是一个完全由 JavaScript 驱动的文档程序。

主页

文档页

强大的 Markdown 编辑器

它如何运行

为了方便部署，尽量减少对宿主机环境的改动，VueDoc 运行在 Docker 容器中，装好就能用。

Demo: https://doc.krunk.cn/

它的原理

你确定需要看原理？

后端驱动

VueDoc 的后端由 Node.js 驱动。它的功能比较单一，用不着复杂的数据库，所以数据都存储在 JSON 文件里。每次访问时，服务器直接从内存读取 JSON 数据。

所以我才说，它完全由 JavaScript 驱动。

数据持久化

VueDoc 会延迟把数据写入 JSON 文件。要持久化保存数据，可以把容器里的以下目录映射到本地：

Docker位置

备注

1

/usr/src/app/data

JSON 数据

2

/usr/src/app/images

文章中上传的图片

前端驱动

VueDoc 的前端用 Vue.js 构建，是一个静态的单页面应用。

有兴趣？

懒得联系？可以在留言里留个 QQ 号，有时间的话，说不定我会拉个群。