什么是VueDoc
VueDoc是一个完全由 ==Javascript== 驱动的文档程序。文档编写方式采用==Markdown==进行编写。当前您看到的文档就是VueDoc实现的。
它如何运行
为了方便部署并且减少环境安装和影响,VueDoc运行在Docker环境中。
它的原理
你确定需要看原理?
后端驱动
VueDoc后端由 ==node.js== 进行驱动。由于其功能单一,并不需要复杂的数据库,因此它的数据完全存储在 json 文件中。您的每次访问,都是从服务器的内存中读取 json 数据而已。由于只是从内存里面读取数据,因此它运行非常快。
正是因为如此,所以说它是完全用 Javascript 驱动的产品
数据持久化
VueDoc将数据延迟写入到 json 文件中。为数据持久化存储,可在 Docker 中将下面的文件夹映射到本地:
:::: tabs
::: tab-pane 新版
6.x目前尚未发布,安装时请按照5.x及旧版安装
# |
Docker内位置 |
备注 |
1 |
/usr/src/app/content |
数据及上传 |
::: |
|
|
::: tab-pane 5.x及旧版
# |
Docker内位置 |
备注 |
1 |
/usr/src/app/data |
数据 json |
2 |
/usr/src/app/images |
文章中上传的图片 |
::: |
|
|
::::
前端驱动
VueDoc的前端使用 ==Vue.js== + ==Naive-UI==进行构建,是一个静态的单页面应用。
搜索引擎友好
VueDoc的页面可以被搜索引擎抓取、并提供了站点地图功能以便直接向搜索引擎提交。