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

什么是VueDoc

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

主页

文档页

强大的 MarkDown 编辑器

它如何运行

为了方便部署并且减少环境安装和影响，VueDoc运行在Docker环境中。安装后直接运行。

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

它的原理

你确定需要看原理？

后端驱动

VueDoc后端由 node.js 进行驱动。由于其功能单一，并不需要复杂的数据库，因此它的数据完全存储在 json 文件中。您的每次访问，都是从服务器的内存中读取 json 数据而已。

正是因为如此，所以说它是完全用 Javascript 驱动的产品

数据持久化

VueDoc将数据延迟写入到 json 文件中。为数据持久化存储，可在 Docker 中将下面的文件夹映射到本地：

Docker位置

备注

1

/usr/src/app/data

数据 json

2

/usr/src/app/images

文章中上传的图片

前端驱动

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

有兴趣？

懒得联系？留言QQ说不定有时间的话会来拉个群