From c24503ba9262bb4b8ab6e59413d0f73b76d27885 Mon Sep 17 00:00:00 2001 From: "Mr.Hope" Date: Tue, 28 Feb 2023 15:37:39 +0800 Subject: [PATCH] docs: update reference --- docs/ref/api.md | 16 +-- docs/ref/baota.md | 10 +- docs/ref/changelog.md | 234 +++++++++++++++++------------------------- docs/ref/dev.md | 45 ++++---- docs/ref/dsm.md | 44 ++++---- docs/ref/env.md | 33 +++--- docs/ref/faq.md | 50 ++++----- docs/ref/log.md | 16 ++- 8 files changed, 207 insertions(+), 241 deletions(-) diff --git a/docs/ref/api.md b/docs/ref/api.md index d8ee2bfb3..92671d0b4 100644 --- a/docs/ref/api.md +++ b/docs/ref/api.md @@ -5,21 +5,25 @@ icon: http 目前还没写专门的 API 参考，但是可以用生成的 `swagger` 做为参考。其中 `public` 标签下的都是不需要鉴权的。 -可以在后台侧边栏中点击关于，然后点击关于界面的`API文档`来进入 API 文档页面： +可以在后台侧边栏中点击关于，然后点击关于界面的 `API 文档` 来进入 API 文档页面： ![API 文档入口](https://pic.mereith.com/img/0b487fe87735562feff3825b040c5353.clipboard-2022-08-29.png) 由于分离式的设计，你完全可以把本项目当作无头 CMS 来使用。只用本项目的后端和 server，自己写前端，或者自己写一个 `hexo` 的渲染器。 -（也许以后我会加上一些其他的渲染器支持，比如对接 `hexo` 和 `vue-press`） +（也许以后我会加上一些其他的渲染器支持，比如对接 `hexo` 和 `vuepress`） -> swagger 路径： /swagger -> 参考： [https://blog-demo.mereith.com/swagger](https://blog-demo.mereith.com/swagger) +::: note -举个例子，你可以通过 GET /api/public/article/:id ，获取置顶文章的 JSON 内容。 +- swagger 路径： `/swagger` +- 参考： [https://blog-demo.mereith.com/swagger](https://blog-demo.mereith.com/swagger) + +::: + +举个例子，你可以通过 `GET /api/public/article/:id` ，获取置顶文章的 JSON 内容。 你可以点击这个链接看一下效果： [https://blog-demo.mereith.com/api/public/article/28](https://blog-demo.mereith.com/api/public/article/28) ## 关于鉴权的接口 -所有需要鉴权的接口是通过请求头中 `token` 字段鉴权的，可以复制登录后台后的请求头中的 `token` 来使用鉴权 api，有效期和登录过期时间相同，可通过后台中的高级设置调整过期时间。 \ No newline at end of file +所有需要鉴权的接口是通过请求头中 `token` 字段鉴权的，可以复制登录后台后的请求头中的 `token` 来使用鉴权 API，有效期和登录过期时间相同，可通过后台中的高级设置调整过期时间。 diff --git a/docs/ref/baota.md b/docs/ref/baota.md index 94414f4ae..3409a328a 100644 --- a/docs/ref/baota.md +++ b/docs/ref/baota.md @@ -3,11 +3,11 @@ title: 通过宝塔面板部署 icon: linux --- -::: warn 温馨提示 +::: tip 温馨提示 VanBlog 现在支持一键脚本部署了。经过测试，宝塔也可以通过一键脚本进行部署。 -建议您通过[一键脚本部署](/guide/docker.md#一键脚本部署)，这样后期可以通过脚本一键升级会方便一些。 +建议您通过[一键脚本部署](../guide/docker.md#一键脚本部署)，这样后期可以通过脚本一键升级会方便一些。 如果您想通过图形化部署，请看下文。 @@ -87,7 +87,7 @@ services: 等启动完毕后即可！ -和普通部署一样，浏览器打开 `http://<你的域名>:8880/admin/init` ，并按照提示初始化即可。具体设置项可以参考 [站点配置](/feature/basic/setting.md) +和普通部署一样，浏览器打开 `http://<你的域名>:8880/admin/init` ，并按照提示初始化即可。具体设置项可以参考 [站点配置](../feature/basic/setting.md)。 有问题的话可以查看一下容器的日志进行排查。 @@ -97,7 +97,7 @@ services: ![](https://pic.mereith.com/img/47a03229d46e9120ad1e7bf1abf4b504.clipboard-2022-09-14.png) -如果你只部署 `VanBlog` ，并想关闭 `nginx` ，请输入以下命令关闭 `nginx`: +如果你只部署 `VanBlog` ，并想关闭 Ngnix ，请输入以下命令关闭 Ngnix: ```bash nginx -s stop @@ -105,4 +105,4 @@ nginx -s stop ## 反代 -请移步 [反代](/guide/nginx.md) +请移步 [反代](../guide/nginx.md)。 diff --git a/docs/ref/changelog.md b/docs/ref/changelog.md index b6a760fcb..4dc1dd8b8 100644 --- a/docs/ref/changelog.md +++ b/docs/ref/changelog.md @@ -3,280 +3,236 @@ title: 更新日志 icon: update --- - ## [0.48.0](https://github.com/Mereithhh/van-blog/compare/v0.47.0...v0.48.0) (2023-02-27) - ### ✨ Features | 新功能 -* 图片增加水印功能 [#163](https://github.com/Mereithhh/van-blog/issues/163) ([8d6e8f3](https://github.com/Mereithhh/van-blog/commit/8d6e8f3eedf4b0e7c1879361bf5192bb2ef384a9)) - +- 图片增加水印功能 [#163](https://github.com/Mereithhh/van-blog/issues/163) ([8d6e8f3](https://github.com/Mereithhh/van-blog/commit/8d6e8f3eedf4b0e7c1879361bf5192bb2ef384a9)) ### ✏️ Documentation | 文档 -* 增加关于水印功能的文档 ([2fb2da4](https://github.com/Mereithhh/van-blog/commit/2fb2da44fa1cdfae56cd2995153e41e8396d61bc)) -* 增加备份与迁移文档说明 ([37fcfb9](https://github.com/Mereithhh/van-blog/commit/37fcfb92d98649f1d3abe41e556d4b1c8e95239d)) -* 增加自定义路径相关的文档 ([788bf86](https://github.com/Mereithhh/van-blog/commit/788bf86bd63678b2d52010c1e0f91b184d03d016)) -* 更新文档 ([5bc5ebf](https://github.com/Mereithhh/van-blog/commit/5bc5ebf7ee6a85c38437f73dcbcf3d5d46194ae9)) - +- 增加关于水印功能的文档 ([2fb2da4](https://github.com/Mereithhh/van-blog/commit/2fb2da44fa1cdfae56cd2995153e41e8396d61bc)) +- 增加备份与迁移文档说明 ([37fcfb9](https://github.com/Mereithhh/van-blog/commit/37fcfb92d98649f1d3abe41e556d4b1c8e95239d)) +- 增加自定义路径相关的文档 ([788bf86](https://github.com/Mereithhh/van-blog/commit/788bf86bd63678b2d52010c1e0f91b184d03d016)) +- 更新文档 ([5bc5ebf](https://github.com/Mereithhh/van-blog/commit/5bc5ebf7ee6a85c38437f73dcbcf3d5d46194ae9)) ### 🐛 Bug Fixes | Bug 修复 -* 图片管理中剪切板上传图片失效&水印距离下面位置调高一点 ([646884d](https://github.com/Mereithhh/van-blog/commit/646884d624169077d1f431f932f08408ab98f11a)) +- 图片管理中剪切板上传图片失效&水印距离下面位置调高一点 ([646884d](https://github.com/Mereithhh/van-blog/commit/646884d624169077d1f431f932f08408ab98f11a)) ## [0.47.0](https://github.com/Mereithhh/vanblog/compare/v0.46.0...v0.47.0) (2023-02-26) - ### ✨ Features | 新功能 -* use search-pro plugin ([d5a2ab4](https://github.com/Mereithhh/vanblog/commit/d5a2ab455146d7592dfd6a7f0b4cd0f4d3984a26)) -* 自定义文章路径 [#159](https://github.com/Mereithhh/vanblog/issues/159) ([14394b5](https://github.com/Mereithhh/vanblog/commit/14394b596d1933069b02dced14d757b3ad1825d8)) - +- use search-pro plugin ([d5a2ab4](https://github.com/Mereithhh/vanblog/commit/d5a2ab455146d7592dfd6a7f0b4cd0f4d3984a26)) +- 自定义文章路径 [#159](https://github.com/Mereithhh/vanblog/issues/159) ([14394b5](https://github.com/Mereithhh/vanblog/commit/14394b596d1933069b02dced14d757b3ad1825d8)) ### 🚀 Chore | 构建/工程依赖/工具 -* fix typos ([88a30b6](https://github.com/Mereithhh/vanblog/commit/88a30b6effbcbaf6f4f4dc774fc7bc0b4a092722)) -* update lockfile ([c74e339](https://github.com/Mereithhh/vanblog/commit/c74e3393b6490396bab3042b64a6dc91148727d2)) - +- fix typos ([88a30b6](https://github.com/Mereithhh/vanblog/commit/88a30b6effbcbaf6f4f4dc774fc7bc0b4a092722)) +- update lockfile ([c74e339](https://github.com/Mereithhh/vanblog/commit/c74e3393b6490396bab3042b64a6dc91148727d2)) ### ✏️ Documentation | 文档 -* tweaks ([30c5758](https://github.com/Mereithhh/vanblog/commit/30c5758831663eb7d9f8ed81644e86204d46ac46)) -* update docs ([8bae067](https://github.com/Mereithhh/vanblog/commit/8bae0677981ceee6c620071f1ceb6e9be983cef2)) -* 增加关于接口鉴权的描述文字 ([8eda958](https://github.com/Mereithhh/vanblog/commit/8eda9587685c7ff7138311e909858c255c2589e8)) -* 更新文档 ([900890f](https://github.com/Mereithhh/vanblog/commit/900890f5c86a24cdefc7970b951fa1b8beb1ff7c)) -* 更新文档 ([b728912](https://github.com/Mereithhh/vanblog/commit/b728912a9255070a5d057275f5edb4c66f4c9bb2)) -* 更新谁在使用' ([900ca4c](https://github.com/Mereithhh/vanblog/commit/900ca4c481517dda9cd54bd27c22ef806391b3a2)) +- tweaks ([30c5758](https://github.com/Mereithhh/vanblog/commit/30c5758831663eb7d9f8ed81644e86204d46ac46)) +- update docs ([8bae067](https://github.com/Mereithhh/vanblog/commit/8bae0677981ceee6c620071f1ceb6e9be983cef2)) +- 增加关于接口鉴权的描述文字 ([8eda958](https://github.com/Mereithhh/vanblog/commit/8eda9587685c7ff7138311e909858c255c2589e8)) +- 更新文档 ([900890f](https://github.com/Mereithhh/vanblog/commit/900890f5c86a24cdefc7970b951fa1b8beb1ff7c)) +- 更新文档 ([b728912](https://github.com/Mereithhh/vanblog/commit/b728912a9255070a5d057275f5edb4c66f4c9bb2)) +- 更新谁在使用' ([900ca4c](https://github.com/Mereithhh/vanblog/commit/900ca4c481517dda9cd54bd27c22ef806391b3a2)) ## [0.46.0](https://github.com/Mereithhh/vanblog/compare/v0.45.6...v0.46.0) (2023-02-25) - ### 🐛 Bug Fixes | Bug 修复 -* 左右切换页面时，内容不更新[#161](https://github.com/Mereithhh/vanblog/issues/161) ([94acb32](https://github.com/Mereithhh/vanblog/commit/94acb322f967f04fd6ca7d0473ed5095b672c5cd)) -* 暗色模式刷新页面代码块重影问题（盲修，不一定完全修好）[#162](https://github.com/Mereithhh/vanblog/issues/162) ([8d888c6](https://github.com/Mereithhh/vanblog/commit/8d888c6cfe72bd45e759c43714f521ec597bf889)) - +- 左右切换页面时，内容不更新[#161](https://github.com/Mereithhh/vanblog/issues/161) ([94acb32](https://github.com/Mereithhh/vanblog/commit/94acb322f967f04fd6ca7d0473ed5095b672c5cd)) +- 暗色模式刷新页面代码块重影问题（盲修，不一定完全修好）[#162](https://github.com/Mereithhh/vanblog/issues/162) ([8d888c6](https://github.com/Mereithhh/vanblog/commit/8d888c6cfe72bd45e759c43714f521ec597bf889)) ### ♻️ Code Refactoring | 代码重构 -* 更新 nextjs 13 后按照新规范修改 Link 标签的使用" ([b453665](https://github.com/Mereithhh/vanblog/commit/b4536650174ed11ce82b7e519e4573e770f36291)) - +- 更新 nextjs 13 后按照新规范修改 Link 标签的使用" ([b453665](https://github.com/Mereithhh/vanblog/commit/b4536650174ed11ce82b7e519e4573e770f36291)) ### ✨ Features | 新功能 -* 升级到 nextjs 13 ([4632b1b](https://github.com/Mereithhh/vanblog/commit/4632b1bdc71965643aff32fbca8f877c22fabe1f)) -* 支持 mac 的 command + k 开启搜索 ([f6ded59](https://github.com/Mereithhh/vanblog/commit/f6ded59de2ec9f8f92de756e71ce4617372f220a)) -* 新建文章或草稿自动跳转到编辑页面 ([baf4e3c](https://github.com/Mereithhh/vanblog/commit/baf4e3c0028067d97020386a0842ee3ac4d5bcf7)) - +- 升级到 nextjs 13 ([4632b1b](https://github.com/Mereithhh/vanblog/commit/4632b1bdc71965643aff32fbca8f877c22fabe1f)) +- 支持 mac 的 command + k 开启搜索 ([f6ded59](https://github.com/Mereithhh/vanblog/commit/f6ded59de2ec9f8f92de756e71ce4617372f220a)) +- 新建文章或草稿自动跳转到编辑页面 ([baf4e3c](https://github.com/Mereithhh/vanblog/commit/baf4e3c0028067d97020386a0842ee3ac4d5bcf7)) ### 💄 Styles | 风格 -* 后台登录框居中&不自动记录密码 ([7174f11](https://github.com/Mereithhh/vanblog/commit/7174f11b8e1d511c7c160f6b3f8d94f232478676)) - +- 后台登录框居中&不自动记录密码 ([7174f11](https://github.com/Mereithhh/vanblog/commit/7174f11b8e1d511c7c160f6b3f8d94f232478676)) ### 🚀 Chore | 构建/工程依赖/工具 - -* server 增加一个不启动 website 前台的模式 ([b2f0b15](https://github.com/Mereithhh/vanblog/commit/b2f0b150d47190c3089b7654afe3a1942f10eb92)) -* server 开发时未制定配置 logs 为当前路径 ([57684a4](https://github.com/Mereithhh/vanblog/commit/57684a40d7c8a05e201fb5c21f8a1b88c090b59d)) -* website 锁定 nextjs 版本 ([a93cb65](https://github.com/Mereithhh/vanblog/commit/a93cb65492e8178e5f66ddd1886bb9def5d72360)) -* 增加一个取消所有进程的命令 ([ee0f564](https://github.com/Mereithhh/vanblog/commit/ee0f5644f48a52eb246fd693177ff53d1d8448fa)) - - - - +- server 增加一个不启动 website 前台的模式 ([b2f0b15](https://github.com/Mereithhh/vanblog/commit/b2f0b150d47190c3089b7654afe3a1942f10eb92)) +- server 开发时未制定配置 logs 为当前路径 ([57684a4](https://github.com/Mereithhh/vanblog/commit/57684a40d7c8a05e201fb5c21f8a1b88c090b59d)) +- website 锁定 nextjs 版本 ([a93cb65](https://github.com/Mereithhh/vanblog/commit/a93cb65492e8178e5f66ddd1886bb9def5d72360)) +- 增加一个取消所有进程的命令 ([ee0f564](https://github.com/Mereithhh/vanblog/commit/ee0f5644f48a52eb246fd693177ff53d1d8448fa)) ### [0.45.6](https://github.com/Mereithhh/van-blog/compare/v0.45.5...v0.45.6) (2023-02-15) - ### 🐛 Bug Fixes | Bug 修复 -* 加密文章解密后目录未加载 ([cd6d43b](https://github.com/Mereithhh/van-blog/commit/cd6d43b9ad1fcc60eabfeb2a7de733468418a172)) -* 大文本数据报错 ([92714c9](https://github.com/Mereithhh/van-blog/commit/92714c92ea37ce882543b4240fb4829861071883)) -* 特殊情况报错 ([f4d3bd0](https://github.com/Mereithhh/van-blog/commit/f4d3bd0f23ae574599c12107f20a03fcae5baf99)) - +- 加密文章解密后目录未加载 ([cd6d43b](https://github.com/Mereithhh/van-blog/commit/cd6d43b9ad1fcc60eabfeb2a7de733468418a172)) +- 大文本数据报错 ([92714c9](https://github.com/Mereithhh/van-blog/commit/92714c92ea37ce882543b4240fb4829861071883)) +- 特殊情况报错 ([f4d3bd0](https://github.com/Mereithhh/van-blog/commit/f4d3bd0f23ae574599c12107f20a03fcae5baf99)) ### ✏️ Documentation | 文档 -* 更新文档 ([6ffc8c2](https://github.com/Mereithhh/van-blog/commit/6ffc8c2f710b8fca1fcc95849053f1e3183a3fdc)) -* 更新文档 ([50729a5](https://github.com/Mereithhh/van-blog/commit/50729a5d9abbcc94ad0e8ed0249ded963b711135)) -* 更新文档 ([7e5f9fd](https://github.com/Mereithhh/van-blog/commit/7e5f9fd992c14c33337fbbce9a2646aa53f2c20a)) - +- 更新文档 ([6ffc8c2](https://github.com/Mereithhh/van-blog/commit/6ffc8c2f710b8fca1fcc95849053f1e3183a3fdc)) +- 更新文档 ([50729a5](https://github.com/Mereithhh/van-blog/commit/50729a5d9abbcc94ad0e8ed0249ded963b711135)) +- 更新文档 ([7e5f9fd](https://github.com/Mereithhh/van-blog/commit/7e5f9fd992c14c33337fbbce9a2646aa53f2c20a)) ### 🚀 Chore | 构建/工程依赖/工具 -* **release:** 0.45.6 ([8bd73d8](https://github.com/Mereithhh/van-blog/commit/8bd73d8247ed52f5ae1666c672209f95dd936f88)) -* **release:** 0.45.7 ([60fd157](https://github.com/Mereithhh/van-blog/commit/60fd1575382b49240eafe60860109de995612ac2)) -* 构建报错 ([72ff966](https://github.com/Mereithhh/van-blog/commit/72ff96691053f484019ec4fe9ace72b6655fcd4b)) - +- **release:** 0.45.6 ([8bd73d8](https://github.com/Mereithhh/van-blog/commit/8bd73d8247ed52f5ae1666c672209f95dd936f88)) +- **release:** 0.45.7 ([60fd157](https://github.com/Mereithhh/van-blog/commit/60fd1575382b49240eafe60860109de995612ac2)) +- 构建报错 ([72ff966](https://github.com/Mereithhh/van-blog/commit/72ff96691053f484019ec4fe9ace72b6655fcd4b)) ### ⏪ Revert | 回退 -* 构建错误重新发版 ([8cd4cca](https://github.com/Mereithhh/van-blog/commit/8cd4ccac36ec2d0b46cd07c21bf044f44674f100)) +- 构建错误重新发版 ([8cd4cca](https://github.com/Mereithhh/van-blog/commit/8cd4ccac36ec2d0b46cd07c21bf044f44674f100)) ### [0.45.5](https://github.com/Mereithhh/van-blog/compare/v0.45.4...v0.45.5) (2023-02-08) - ### ✏️ Documentation | 文档 -* 更新文档 ([7f27784](https://github.com/Mereithhh/van-blog/commit/7f27784f0603167e7dd3e9d22de7eef6dab3388f)) - +- 更新文档 ([7f27784](https://github.com/Mereithhh/van-blog/commit/7f27784f0603167e7dd3e9d22de7eef6dab3388f)) ### 🐛 Bug Fixes | Bug 修复 -* 前台挂掉 [#149](https://github.com/Mereithhh/van-blog/issues/149) ([6a136aa](https://github.com/Mereithhh/van-blog/commit/6a136aaa45f3d73dd15deff8dba8699a5c1be2f3)) +- 前台挂掉 [#149](https://github.com/Mereithhh/van-blog/issues/149) ([6a136aa](https://github.com/Mereithhh/van-blog/commit/6a136aaa45f3d73dd15deff8dba8699a5c1be2f3)) ### [0.45.4](https://github.com/Mereithhh/van-blog/compare/v0.45.3...v0.45.4) (2023-02-07) - ### ✏️ Documentation | 文档 -* 更新文档 ([bee0f58](https://github.com/Mereithhh/van-blog/commit/bee0f585b73c384e733bd801085c459fd5077983)) - +- 更新文档 ([bee0f58](https://github.com/Mereithhh/van-blog/commit/bee0f585b73c384e733bd801085c459fd5077983)) ### 🐛 Bug Fixes | Bug 修复 -* 分类数量显示不准确 [#146](https://github.com/Mereithhh/van-blog/issues/146) ([9a20c05](https://github.com/Mereithhh/van-blog/commit/9a20c051f804328f7a7720d25a1e5c14625a5664)) - +- 分类数量显示不准确 [#146](https://github.com/Mereithhh/van-blog/issues/146) ([9a20c05](https://github.com/Mereithhh/van-blog/commit/9a20c051f804328f7a7720d25a1e5c14625a5664)) ### ✨ Features | 新功能 -* 后台编辑器换行与前台保持统一，两个回车才换行 [#148](https://github.com/Mereithhh/van-blog/issues/148) ([c4939b6](https://github.com/Mereithhh/van-blog/commit/c4939b6e867a9a691f1937be642b05ba4b0b3da3)) +- 后台编辑器换行与前台保持统一，两个回车才换行 [#148](https://github.com/Mereithhh/van-blog/issues/148) ([c4939b6](https://github.com/Mereithhh/van-blog/commit/c4939b6e867a9a691f1937be642b05ba4b0b3da3)) ### [0.45.3](https://github.com/Mereithhh/van-blog/compare/v0.45.2...v0.45.3) (2023-02-04) - ### ✏️ Documentation | 文档 -* 更新文档 ([b730bf1](https://github.com/Mereithhh/van-blog/commit/b730bf1bac87a5e2eddca03463a9ede9dd4a5127)) - +- 更新文档 ([b730bf1](https://github.com/Mereithhh/van-blog/commit/b730bf1bac87a5e2eddca03463a9ede9dd4a5127)) ### 🐛 Bug Fixes | Bug 修复 -* 在设置自动主题的浏览器或设备上，后台编辑器预览的暗色主题无法切换 ([02e757e](https://github.com/Mereithhh/van-blog/commit/02e757ee1724132345e56d1bed35ef495bc699f5)) +- 在设置自动主题的浏览器或设备上，后台编辑器预览的暗色主题无法切换 ([02e757e](https://github.com/Mereithhh/van-blog/commit/02e757ee1724132345e56d1bed35ef495bc699f5)) ### [0.45.2](https://github.com/Mereithhh/van-blog/compare/v0.45.1...v0.45.2) (2023-02-04) - ### ✏️ Documentation | 文档 -* 更新文档 ([ac6fbc9](https://github.com/Mereithhh/van-blog/commit/ac6fbc900e9895c159a2c93f6d2357dab14f2ac1)) - +- 更新文档 ([ac6fbc9](https://github.com/Mereithhh/van-blog/commit/ac6fbc900e9895c159a2c93f6d2357dab14f2ac1)) ### 🐛 Bug Fixes | Bug 修复 -* 域名带有端口号的情况下内置图床无法加载作者头像 ([4a9d507](https://github.com/Mereithhh/van-blog/commit/4a9d5076d2ea609e1385e0179f262a518e87733f)) - +- 域名带有端口号的情况下内置图床无法加载作者头像 ([4a9d507](https://github.com/Mereithhh/van-blog/commit/4a9d5076d2ea609e1385e0179f262a518e87733f)) ### ✨ Features | 新功能 -* 增加撤销重做按钮 ([1fa3829](https://github.com/Mereithhh/van-blog/commit/1fa382900534a0de845f3479de958da4f2b2542d)) +- 增加撤销重做按钮 ([1fa3829](https://github.com/Mereithhh/van-blog/commit/1fa382900534a0de845f3479de958da4f2b2542d)) ### [0.45.1](https://github.com/Mereithhh/van-blog/compare/v0.45.0...v0.45.1) (2023-02-03) - ### ✏️ Documentation | 文档 -* 更新文档 ([3e8fcac](https://github.com/Mereithhh/van-blog/commit/3e8fcac72e5840493b78c408ff5be1af897acffa)) - +- 更新文档 ([3e8fcac](https://github.com/Mereithhh/van-blog/commit/3e8fcac72e5840493b78c408ff5be1af897acffa)) ### 🐛 Bug Fixes | Bug 修复 -* isr 更新报错导致 server 不正常退出 ([9efe654](https://github.com/Mereithhh/van-blog/commit/9efe6540775a471d3fa40c69204c7e5fd903e227)) +- isr 更新报错导致 server 不正常退出 ([9efe654](https://github.com/Mereithhh/van-blog/commit/9efe6540775a471d3fa40c69204c7e5fd903e227)) ## [0.45.0](https://github.com/Mereithhh/van-blog/compare/v0.44.0...v0.45.0) (2023-02-02) - ### ⚡ Performance Improvements | 性能优化 -* 增加索引 ([a4fcaca](https://github.com/Mereithhh/van-blog/commit/a4fcaca69bdb907f0d58b04bc246e4dc8c4791da)) - +- 增加索引 ([a4fcaca](https://github.com/Mereithhh/van-blog/commit/a4fcaca69bdb907f0d58b04bc246e4dc8c4791da)) ### 🚀 Chore | 构建/工程依赖/工具 -* 固定 admin 构建镜像版本，防止构建报错 ([5c6111c](https://github.com/Mereithhh/van-blog/commit/5c6111c519e571006658af75f5eb41d26878ddbc)) - +- 固定 admin 构建镜像版本，防止构建报错 ([5c6111c](https://github.com/Mereithhh/van-blog/commit/5c6111c519e571006658af75f5eb41d26878ddbc)) ### ✨ Features | 新功能 -* isr 默认按需更新，非按需时特定情况强制渲染 ([0e8539c](https://github.com/Mereithhh/van-blog/commit/0e8539cf44cc7c1a37624d293063bfe2eed44ee3)) -* 分类加密 ([374e6ef](https://github.com/Mereithhh/van-blog/commit/374e6efac60786d5d2ec767277b15662e92658e4)) -* 基于文件管理的自定义页面功能 ([eae6a8b](https://github.com/Mereithhh/van-blog/commit/eae6a8b88e7dd6fd1fe0c2e42fff201b309a47d6)) -* 客制化可自定义 head 下标签，会跟随前台进行静态页面生成，可用于验证网站所有权 ([041eea4](https://github.com/Mereithhh/van-blog/commit/041eea47abb90405486f6f95014c88c867ec3c6e)) -* 新增静态资源更新策略配置，默认采用 nextjs 自动模式以节约资源 ([5fe6898](https://github.com/Mereithhh/van-blog/commit/5fe68982a102ee840dc2eb877adfb748e610d529)) -* 更新内置 picgo-core 到 1.5.0 ([e587a4e](https://github.com/Mereithhh/van-blog/commit/e587a4ef5643440c6402a024d376b49882820eac)) -* 更新内置 waline 到 1.26.0 ([c28ec1f](https://github.com/Mereithhh/van-blog/commit/c28ec1f2d03c738023f3e8b7fd9d7612e123370c)) -* 点击导航栏站点名称时返回首页 ([2a338c2](https://github.com/Mereithhh/van-blog/commit/2a338c2cd250e2e1107aa314ad00b723cddac828)) - +- isr 默认按需更新，非按需时特定情况强制渲染 ([0e8539c](https://github.com/Mereithhh/van-blog/commit/0e8539cf44cc7c1a37624d293063bfe2eed44ee3)) +- 分类加密 ([374e6ef](https://github.com/Mereithhh/van-blog/commit/374e6efac60786d5d2ec767277b15662e92658e4)) +- 基于文件管理的自定义页面功能 ([eae6a8b](https://github.com/Mereithhh/van-blog/commit/eae6a8b88e7dd6fd1fe0c2e42fff201b309a47d6)) +- 客制化可自定义 head 下标签，会跟随前台进行静态页面生成，可用于验证网站所有权 ([041eea4](https://github.com/Mereithhh/van-blog/commit/041eea47abb90405486f6f95014c88c867ec3c6e)) +- 新增静态资源更新策略配置，默认采用 nextjs 自动模式以节约资源 ([5fe6898](https://github.com/Mereithhh/van-blog/commit/5fe68982a102ee840dc2eb877adfb748e610d529)) +- 更新内置 picgo-core 到 1.5.0 ([e587a4e](https://github.com/Mereithhh/van-blog/commit/e587a4ef5643440c6402a024d376b49882820eac)) +- 更新内置 waline 到 1.26.0 ([c28ec1f](https://github.com/Mereithhh/van-blog/commit/c28ec1f2d03c738023f3e8b7fd9d7612e123370c)) +- 点击导航栏站点名称时返回首页 ([2a338c2](https://github.com/Mereithhh/van-blog/commit/2a338c2cd250e2e1107aa314ad00b723cddac828)) ### ✏️ Documentation | 文档 -* 增加静态页面更新策略文档 ([1366eb3](https://github.com/Mereithhh/van-blog/commit/1366eb35110821d4167b7929f6e2dd3e200b24af)) -* 新版自定义页面文档 ([2282634](https://github.com/Mereithhh/van-blog/commit/2282634c7035fec74e70edce2a889829a0c24c33)) -* 更新图床文档 ([df792e8](https://github.com/Mereithhh/van-blog/commit/df792e824288679a81d3f4c77d8d3a6cb711c39e)) -* 更新开发指南 ([8a95244](https://github.com/Mereithhh/van-blog/commit/8a95244c80b31b8843d1e2c29316ce246a7212a5)) -* 更新文档 ([385841e](https://github.com/Mereithhh/van-blog/commit/385841e7c6b4aacab1896c04eb271bfdf9513275)) -* 更新文档 ([0c3d5ef](https://github.com/Mereithhh/van-blog/commit/0c3d5ef761c884ffc54d89167c9760dfb84f4d65)) -* 更新谁在使用 ([939f560](https://github.com/Mereithhh/van-blog/commit/939f560e139e7db6fb0f4635ef2322b1470408df)) -* 更新谁在使用 ([c90a17e](https://github.com/Mereithhh/van-blog/commit/c90a17ef9074c6dea7e6c51de9acfc5be641fe7b)) - +- 增加静态页面更新策略文档 ([1366eb3](https://github.com/Mereithhh/van-blog/commit/1366eb35110821d4167b7929f6e2dd3e200b24af)) +- 新版自定义页面文档 ([2282634](https://github.com/Mereithhh/van-blog/commit/2282634c7035fec74e70edce2a889829a0c24c33)) +- 更新图床文档 ([df792e8](https://github.com/Mereithhh/van-blog/commit/df792e824288679a81d3f4c77d8d3a6cb711c39e)) +- 更新开发指南 ([8a95244](https://github.com/Mereithhh/van-blog/commit/8a95244c80b31b8843d1e2c29316ce246a7212a5)) +- 更新文档 ([385841e](https://github.com/Mereithhh/van-blog/commit/385841e7c6b4aacab1896c04eb271bfdf9513275)) +- 更新文档 ([0c3d5ef](https://github.com/Mereithhh/van-blog/commit/0c3d5ef761c884ffc54d89167c9760dfb84f4d65)) +- 更新谁在使用 ([939f560](https://github.com/Mereithhh/van-blog/commit/939f560e139e7db6fb0f4635ef2322b1470408df)) +- 更新谁在使用 ([c90a17e](https://github.com/Mereithhh/van-blog/commit/c90a17ef9074c6dea7e6c51de9acfc5be641fe7b)) ### 🐛 Bug Fixes | Bug 修复 -* firefox 浏览器目录滚动条白条 [#132](https://github.com/Mereithhh/van-blog/issues/132) ([23d753c](https://github.com/Mereithhh/van-blog/commit/23d753cc78dc32b4467a4db81497240f55f703d6)) -* isr 配置表单初始值未带入 ([f56f828](https://github.com/Mereithhh/van-blog/commit/f56f828f56afe7b26a7f486d4b8c173cc3eb75c1)) -* isr 配置读取报错 ([2534cec](https://github.com/Mereithhh/van-blog/commit/2534cec1019ca68c0335dd0cf72675e70bc6062a)) -* 分类接口获取报错 ([772ed36](https://github.com/Mereithhh/van-blog/commit/772ed362ea3d768f8bd4c323d779b8a2ae195537)) -* 更新后台 isr 帮助文档指向' ([84bdcf3](https://github.com/Mereithhh/van-blog/commit/84bdcf3d6288da38bc05ba13eeeac3176e313989)) -* 目录丢失问题 [#117](https://github.com/Mereithhh/van-blog/issues/117) ([72659f6](https://github.com/Mereithhh/van-blog/commit/72659f65173a8f1309e2dfa39eafcb19dd33ba47)) -* 目录标题相同时，显示跳转异常 [#112](https://github.com/Mereithhh/van-blog/issues/112) ([5ac2f5f](https://github.com/Mereithhh/van-blog/commit/5ac2f5ff7cc80c5de0c4f700341fbee6a02fa5c5)) -* 获取分类接口报错 ([dcd9083](https://github.com/Mereithhh/van-blog/commit/dcd908355bd28f0ac16d81777534b59ac51eb147)) +- firefox 浏览器目录滚动条白条 [#132](https://github.com/Mereithhh/van-blog/issues/132) ([23d753c](https://github.com/Mereithhh/van-blog/commit/23d753cc78dc32b4467a4db81497240f55f703d6)) +- isr 配置表单初始值未带入 ([f56f828](https://github.com/Mereithhh/van-blog/commit/f56f828f56afe7b26a7f486d4b8c173cc3eb75c1)) +- isr 配置读取报错 ([2534cec](https://github.com/Mereithhh/van-blog/commit/2534cec1019ca68c0335dd0cf72675e70bc6062a)) +- 分类接口获取报错 ([772ed36](https://github.com/Mereithhh/van-blog/commit/772ed362ea3d768f8bd4c323d779b8a2ae195537)) +- 更新后台 isr 帮助文档指向' ([84bdcf3](https://github.com/Mereithhh/van-blog/commit/84bdcf3d6288da38bc05ba13eeeac3176e313989)) +- 目录丢失问题 [#117](https://github.com/Mereithhh/van-blog/issues/117) ([72659f6](https://github.com/Mereithhh/van-blog/commit/72659f65173a8f1309e2dfa39eafcb19dd33ba47)) +- 目录标题相同时，显示跳转异常 [#112](https://github.com/Mereithhh/van-blog/issues/112) ([5ac2f5f](https://github.com/Mereithhh/van-blog/commit/5ac2f5ff7cc80c5de0c4f700341fbee6a02fa5c5)) +- 获取分类接口报错 ([dcd9083](https://github.com/Mereithhh/van-blog/commit/dcd908355bd28f0ac16d81777534b59ac51eb147)) ## [0.44.0](https://github.com/Mereithhh/van-blog/compare/v0.43.1...v0.44.0) (2022-12-19) - ### 💄 Styles | 风格 -* 一级标题目录加缩进&移动端目录样式优化 [#100](https://github.com/Mereithhh/van-blog/issues/100) ([fb6dc9b](https://github.com/Mereithhh/van-blog/commit/fb6dc9b0bda2d0786fd2195b0535cccca40f7d25)) - +- 一级标题目录加缩进&移动端目录样式优化 [#100](https://github.com/Mereithhh/van-blog/issues/100) ([fb6dc9b](https://github.com/Mereithhh/van-blog/commit/fb6dc9b0bda2d0786fd2195b0535cccca40f7d25)) ### ✨ Features | 新功能 -* 升级内置 waline 到 v1.25.1 ([0379b1c](https://github.com/Mereithhh/van-blog/commit/0379b1c127dcd3cbbea1f0bcaf16f9d83979a41b)) -* 联系方式中增加 gitee [#81](https://github.com/Mereithhh/van-blog/issues/81) ([7a00bb6](https://github.com/Mereithhh/van-blog/commit/7a00bb6b4ec1a59e76fa9d1dd33aa24ad8d47331)) - +- 升级内置 waline 到 v1.25.1 ([0379b1c](https://github.com/Mereithhh/van-blog/commit/0379b1c127dcd3cbbea1f0bcaf16f9d83979a41b)) +- 联系方式中增加 gitee [#81](https://github.com/Mereithhh/van-blog/issues/81) ([7a00bb6](https://github.com/Mereithhh/van-blog/commit/7a00bb6b4ec1a59e76fa9d1dd33aa24ad8d47331)) ### 🚀 Chore | 构建/工程依赖/工具 -* **release:** 0.44.0 ([c64efdd](https://github.com/Mereithhh/van-blog/commit/c64efdd437ef6d8fec8d7d785bcd3a51f0bfb4e4)) -* 增加一个方便开发的一键命令&脚本 ([f9c945e](https://github.com/Mereithhh/van-blog/commit/f9c945e2314bccf5db628f42408ab14b8f914b53)) - +- **release:** 0.44.0 ([c64efdd](https://github.com/Mereithhh/van-blog/commit/c64efdd437ef6d8fec8d7d785bcd3a51f0bfb4e4)) +- 增加一个方便开发的一键命令&脚本 ([f9c945e](https://github.com/Mereithhh/van-blog/commit/f9c945e2314bccf5db628f42408ab14b8f914b53)) ### ✏️ Documentation | 文档 -* 增加一个外置 cos 图床配置指南 ([177c318](https://github.com/Mereithhh/van-blog/commit/177c31811a4cccafbea69a9284f03457f851d0fc)) -* 更新文档 ([cb01dfe](https://github.com/Mereithhh/van-blog/commit/cb01dfe0cec2429a658096aba1b08ef5b8c23826)) -* 更新文档 ([4b37839](https://github.com/Mereithhh/van-blog/commit/4b378395c7cbad1bf68bff2ad7a980333fdbed2e)) -* 更新文档 ([8660fe9](https://github.com/Mereithhh/van-blog/commit/8660fe9c200053cf462c5410ae2f32ef621d3f36)) -* 更新文档 ([f22178f](https://github.com/Mereithhh/van-blog/commit/f22178f5d456e7e81d3c949514d0fa0ab3d70f66)) -* 更新文档 ([1fc1ab9](https://github.com/Mereithhh/van-blog/commit/1fc1ab9ab41713744e2402171bb05fa10850ba2d)) -* 更新谁在使用 ([098ba5b](https://github.com/Mereithhh/van-blog/commit/098ba5b8d51d041a3d81b93a6f466f1baaa8b2ba)) -* 添加样例 ([3590efd](https://github.com/Mereithhh/van-blog/commit/3590efd7067eeedd967c494ca593d72c25a29624)) - +- 增加一个外置 cos 图床配置指南 ([177c318](https://github.com/Mereithhh/van-blog/commit/177c31811a4cccafbea69a9284f03457f851d0fc)) +- 更新文档 ([cb01dfe](https://github.com/Mereithhh/van-blog/commit/cb01dfe0cec2429a658096aba1b08ef5b8c23826)) +- 更新文档 ([4b37839](https://github.com/Mereithhh/van-blog/commit/4b378395c7cbad1bf68bff2ad7a980333fdbed2e)) +- 更新文档 ([8660fe9](https://github.com/Mereithhh/van-blog/commit/8660fe9c200053cf462c5410ae2f32ef621d3f36)) +- 更新文档 ([f22178f](https://github.com/Mereithhh/van-blog/commit/f22178f5d456e7e81d3c949514d0fa0ab3d70f66)) +- 更新文档 ([1fc1ab9](https://github.com/Mereithhh/van-blog/commit/1fc1ab9ab41713744e2402171bb05fa10850ba2d)) +- 更新谁在使用 ([098ba5b](https://github.com/Mereithhh/van-blog/commit/098ba5b8d51d041a3d81b93a6f466f1baaa8b2ba)) +- 添加样例 ([3590efd](https://github.com/Mereithhh/van-blog/commit/3590efd7067eeedd967c494ca593d72c25a29624)) ### 🐛 Bug Fixes | Bug 修复 -* type error ([69db2a5](https://github.com/Mereithhh/van-blog/commit/69db2a5cc46b8f417b12f4e8973e9f5792b1fc8f)) -* 个别分类无法删除修改 [#107](https://github.com/Mereithhh/van-blog/issues/107) ([fdb4ec2](https://github.com/Mereithhh/van-blog/commit/fdb4ec2101f9ee74d45bc42d64947dc1be161252)) -* 修改文章信息时，修改后再次弹窗信息并未及时更新 [#111](https://github.com/Mereithhh/van-blog/issues/111) ([eb46785](https://github.com/Mereithhh/van-blog/commit/eb46785e4cf32e1a8bca3327672bbf96656a4584)) -* 恢恢复后文章 post 后面数字的顺序与原来相反 [#80](https://github.com/Mereithhh/van-blog/issues/80) ([3828d1e](https://github.com/Mereithhh/van-blog/commit/3828d1ef2f927286d38bca6f46eb158f40e81a5d)) -* 目录的滚动条自动跟随失效 [#87](https://github.com/Mereithhh/van-blog/issues/87) ([27db88b](https://github.com/Mereithhh/van-blog/commit/27db88bd5a9a5271ba000042fa045519f052bafc)) -* 重启或更新服务时，一键脚本将删除匿名卷 ([0ff1761](https://github.com/Mereithhh/van-blog/commit/0ff176198bd31fbb948e75ae3c4d063861391bda)) - +- type error ([69db2a5](https://github.com/Mereithhh/van-blog/commit/69db2a5cc46b8f417b12f4e8973e9f5792b1fc8f)) +- 个别分类无法删除修改 [#107](https://github.com/Mereithhh/van-blog/issues/107) ([fdb4ec2](https://github.com/Mereithhh/van-blog/commit/fdb4ec2101f9ee74d45bc42d64947dc1be161252)) +- 修改文章信息时，修改后再次弹窗信息并未及时更新 [#111](https://github.com/Mereithhh/van-blog/issues/111) ([eb46785](https://github.com/Mereithhh/van-blog/commit/eb46785e4cf32e1a8bca3327672bbf96656a4584)) +- 恢恢复后文章 post 后面数字的顺序与原来相反 [#80](https://github.com/Mereithhh/van-blog/issues/80) ([3828d1e](https://github.com/Mereithhh/van-blog/commit/3828d1ef2f927286d38bca6f46eb158f40e81a5d)) +- 目录的滚动条自动跟随失效 [#87](https://github.com/Mereithhh/van-blog/issues/87) ([27db88b](https://github.com/Mereithhh/van-blog/commit/27db88bd5a9a5271ba000042fa045519f052bafc)) +- 重启或更新服务时，一键脚本将删除匿名卷 ([0ff1761](https://github.com/Mereithhh/van-blog/commit/0ff176198bd31fbb948e75ae3c4d063861391bda)) ### ⏪ Revert | 回退 -* 回退改个 bug 重新发版 ([fdd82a1](https://github.com/Mereithhh/van-blog/commit/fdd82a1056e49e852b0134362f581a07a2637005)) +- 回退改个 bug 重新发版 ([fdd82a1](https://github.com/Mereithhh/van-blog/commit/fdd82a1056e49e852b0134362f581a07a2637005)) ### [0.43.1](https://github.com/Mereithhh/van-blog/compare/v0.43.0...v0.43.1) (2022-11-22) diff --git a/docs/ref/dev.md b/docs/ref/dev.md index 576514dd0..701e7c448 100644 --- a/docs/ref/dev.md +++ b/docs/ref/dev.md @@ -3,14 +3,17 @@ title: 开发指南 icon: vscode --- -:::info 提示 -本项目处于初始阶段，如有 bug 请多担待。 +::: info 提示 + +本项目处于早期开发阶段 (Early WIP)，如有 bug 请多担待。 + ::: + 本项目使用了 `JavaScript` 和 `TypeScript` 实现。 如果你想参与 `VanBlog` 开发，可以进群哦： -- [VanBlog  开发群](https://jq.qq.com/?_wv=1027&k=mf2CguM8) +- [VanBlog 开发群](https://jq.qq.com/?_wv=1027&k=mf2CguM8) ## 路径结构 @@ -23,10 +26,10 @@ icon: vscode ├── LICENSE # 开源协议 ├── package.json ├── packages # 代码主体 - | ├── admin # 后台前端代码 - | ├── server # 后端代码 - | ├── waline # 内嵌 waline 评论系统 - | └── website # 前台前端代码 +| ├── admin # 后台前端代码 +| ├── server # 后端代码 +| ├── waline # 内嵌 waline 评论系统 +| └── website # 前台前端代码 ├── README.md └── yarn.lock ``` @@ -35,15 +38,11 @@ icon: vscode 只列出大体上框架级别的，一些细节就直接看代码吧。 -前台： [next.js](https://nextjs.org/)、[react.js](https://reactjs.org/)、[tailwind-css](https://tailwindcss.com/) - -后台： [ant design pro](https://pro.ant.design/zh-CN/)、[ant design](https://ant.design/) - -后端： [nest.js](https://nestjs.com/)、[mongoDB](https://www.mongodb.com/) - -CI： [docker](https://www.docker.com/)、[nginx](https://www.nginx.com/)、[github-actions](https://docs.github.com/cn/actions) - -文档： [vue-press](https://vuepress.vuejs.org/)、[vue-press-hope](https://vuepress-theme-hope.github.io/) +- 前台： [next.js](https://nextjs.org/)、[react.js](https://reactjs.org/)、[tailwind-css](https://tailwindcss.com/) +- 后台： [ant design pro](https://pro.ant.design/zh-CN/)、[ant design](https://ant.design/) +- 后端： [nest.js](https://nestjs.com/)、[mongoDB](https://www.mongodb.com/) +- CI： [docker](https://www.docker.com/)、[nginx](https://www.nginx.com/)、[github-actions](https://docs.github.com/cn/actions) +- 文档： [vuepress](https://vuejs.press/zh/)、[vuepress-theme-hope](https://theme-hope.vuejs.press/zh/) ## 数据库 @@ -51,8 +50,7 @@ CI： [docker](https://www.docker.com/)、[nginx](https://www.nginx.com/)、[git ## 一键开发命令 -为了方便（懒），增加了一键开发命令： -在配置好后端开发的 `yaml` 配置文件后，先安装依赖： +为了方便（懒），增加了一键开发命令。在配置好后端开发的 `yaml` 配置文件后，先安装依赖： ```bash cd packages/server && yarn && cd .. @@ -87,7 +85,7 @@ yarn dev ## 后台开发 -采用 `ant deign pro` +使用 `ant deign pro` ```bash cd packages/admin @@ -101,7 +99,7 @@ yarn start ## 后端开发 -采用 `nestjs` 框架构建。 +使用 `nestjs` 框架构建。 ```bash cd packages/server @@ -115,7 +113,7 @@ yarn start:dev 默认的数据库是本地的 `mongo`，如果你需要修改，可以在本目录（`packages/server`）下新建`config.yaml`： -``` +```yml database: url: mongodb://somemongo:27017/vanBlog?authSource=admin # 配置静态图床的文件夹 @@ -124,7 +122,6 @@ static: waline: db: walineDev log: /code/github/van-blog/log - ``` ## 文档开发 @@ -137,7 +134,7 @@ yarn docs:dev ## 镜像构建 -根目录直接打包就行。 +直接打包根目录即可。 ### act @@ -163,7 +160,7 @@ docker build --build-arg VAN_BLOG_BUILD_SERVER=$VAN_BLOG_BUILD_SERVER -t mereith 另外有一键脚本可以在发版之后自动拷贝 changelog 并发布： -``` +```bash yarn release-doc ``` diff --git a/docs/ref/dsm.md b/docs/ref/dsm.md index 5e3590b67..55a514db4 100644 --- a/docs/ref/dsm.md +++ b/docs/ref/dsm.md @@ -11,23 +11,23 @@ icon: router 在 `Docker` 套件中点击 `映像/新增/从 URL 添加`: -![](https://pic.mereith.com/img/37e817403c5f6b3877780b41f99ea2e0.clipboard-2022-08-29.png) +![添加](https://pic.mereith.com/img/37e817403c5f6b3877780b41f99ea2e0.clipboard-2022-08-29.png) 填入地址为 `mereith/van-blog`： -![](https://pic.mereith.com/img/428cef523d23e2a5d2b19fcb59fb2bf0.clipboard-2022-08-29.png) +![填写地址](https://pic.mereith.com/img/428cef523d23e2a5d2b19fcb59fb2bf0.clipboard-2022-08-29.png) 标签选择默认的 `latest` 即可： -![](https://pic.mereith.com/img/409c41cbe5ebf9d3be1630965b5a6e46.clipboard-2022-08-29.png) +![选择标签](https://pic.mereith.com/img/409c41cbe5ebf9d3be1630965b5a6e46.clipboard-2022-08-29.png) 仿照上面的增加 `mongo` 镜像，版本选择 `4.4.9` 的，如图所示（有些机器不支持 AVX，用最新的会报错）： -![](https://pic.mereith.com/img/acd15a0e47c3a28d78a78c9102a7593e.clipboard-2022-09-15.png) +![添加 mongo 镜像](https://pic.mereith.com/img/acd15a0e47c3a28d78a78c9102a7593e.clipboard-2022-09-15.png) 完成后如图： -![](https://pic.mereith.com/img/94080b16a8305acbd1552ca3b31596bb.clipboard-2022-09-15.png) +![添加结果](https://pic.mereith.com/img/94080b16a8305acbd1552ca3b31596bb.clipboard-2022-09-15.png) ### 创建容器 @@ -48,7 +48,7 @@ icon: router 完成后启动即可。 -### 创建 vanblog 容器 +### 创建 VanBlog 容器 和上面一样，点击 `容器/新建` ，选中刚刚下载的 `mereith/van-blog:latest` 镜像，容器名称为 `vanblog`。 @@ -56,13 +56,17 @@ icon: router ### 环境变量 -点击`高级设置/环境`，其他的都可忽略，但下表的环境变量需要设置/新加： +点击 `高级设置/环境`，其他的都可忽略，但下表的环境变量需要设置/新加： | 名称 | 值 | | ----- | ------------ | | EMAIL | 你自己的邮箱 | -> 参考: [vanblog 文档/环境变量配置](/ref/env.md) 中所示设置好环境变量。 +::: info 参考 + +- 在 [VanBlog 文档/环境变量配置](./env.md) 中所示设置好环境变量。 + +::: ### 链接 @@ -72,22 +76,22 @@ icon: router ### 端口映射 -然后点击下一步，进行端口映射，群晖不能用默认的 80 端口，所以可以映射成其他端口，比如 8880 +然后点击下一步，进行端口映射，群晖不能用默认的 `80` 端口，所以可以映射成其他端口，比如 `8880`。 ![image.png](https://pic.mereith.com/img/5e6a5d6f07af5455b8fd4f06763cf858.image.png) ### 存储空间映射 -可以参考 [vanblog 文档/环境变量配置](/ref/env.md) 中的目录映射部分进行映射。 +可以参考 [VanBlog 文档/环境变量配置](./env.md) 中的目录映射部分进行映射。 其中图床数据的目录映射推荐做一下，不然重置后可能会让你的博客本地图床图片都失效。 -| 容器内目录 | 说明 | -| ------------------------ | ----------------------------------------------------------- | -| /app/static | 图床中数据的存放路径，使用内置图床请务必映射好！ | -| /var/log | 日志的存放路径，包括 access 日志、 Caddy 日志和前台服务日志 | -| /root/.config/caddy | caddy 配置存储路径 | -| /root/.local/share/caddy | caddy 证书存储路径 | +| 容器内目录 | 说明 | +| -------------------------- | ----------------------------------------------------------- | +| `/app/static` | 图床中数据的存放路径，使用内置图床请务必映射好！ | +| `/var/log` | 日志的存放路径，包括 access 日志、 Caddy 日志和前台服务日志 | +| `/root/.config/caddy` | caddy 配置存储路径 | +| `/root/.local/share/caddy` | caddy 证书存储路径 | ### 完成 @@ -95,7 +99,7 @@ icon: router ![image.png](https://pic.mereith.com/img/1e75d553be53f7cea173177035f23cd9.image.png) -### 排错 +### 错误排查 如果发生错误，可以在容器日志中查看报错原因。 @@ -105,4 +109,8 @@ icon: router 但如果你想在公网访问，我的建议是配置好反代后用最终使用的 URL 来访问进行初始化，否则内置图床上传的图片链接可能会有问题。 -> [FAQ](/ref/faq.md) +::: info FAQ + +- [FAQ](./faq.md) + +::: diff --git a/docs/ref/env.md b/docs/ref/env.md index b8a412280..2111cac81 100644 --- a/docs/ref/env.md +++ b/docs/ref/env.md @@ -3,33 +3,34 @@ title: 启动配置 icon: async --- -起容器时可以传递一系列的`环境变量`，修改后需要重启容器生效，具体含义如下： +启动容器时可以传递一系列的 `环境变量`，修改后需要重启容器生效，具体含义如下： ## 环境变量 -::: info 警示 -为避免特殊字符对 bash 的干扰，请务必将环境变量的值用双引号围起来! +::: warning 警示 + +为避免特殊字符对 bash 的干扰，请务必将环境变量的值用双引号围起来! 如 `"https://example.com"` ::: -| 名称 | 必填 | 说明 | 默认值 | -| --------------------- | ---- | --------------------------------------------------------------------------- | ------------------------------------------------ | -| VAN_BLOG_DATABASE_URL | 否 | mongoDB URL | `mongodb://mongo:27017/vanBlog?authSource=admin` | -| VAN_BLOG_CDN_URL | 否 | CDN 部署的 url，在开启之前请不要设置此项。此项会导致公共资源从此 URL 获取。 | `""` | -| VAN_BLOG_WALINE_DB | 否 | 内嵌评论系统的 db 名，默认为 waline | `""` | -| EMAIL | 否 | 用于自动申请 https 证书的邮箱 | `""` | +| 名称 | 必填 | 说明 | 默认值 | +| ----------------------- | ---- | --------------------------------------------------------------------------- | ------------------------------------------------ | +| `VAN_BLOG_DATABASE_URL` | 否 | mongoDB URL | `mongodb://mongo:27017/vanBlog?authSource=admin` | +| `VAN_BLOG_CDN_URL` | 否 | CDN 部署的地址，在开启之前请不要设置此项。此项会导致公共资源从此 URL 获取。 | `""` | +| `VAN_BLOG_WALINE_DB` | 否 | 内嵌评论系统的数据库名，默认为 waline | `""` | +| `EMAIL` | 否 | 用于自动申请 https 证书的邮箱 | `""` | ## 目录映射 -| 容器内目录 | 说明 | -| ------------------------ | ----------------------------------------------------------- | -| /app/static | 图床中数据的存放路径，使用内置图床请务必映射好！ | -| /var/log | 日志的存放路径，包括 access 日志、 Caddy 日志和前台服务日志 | -| /root/.config/caddy | caddy 配置存储路径 | -| /root/.local/share/caddy | caddy 证书存储路径 | +| 容器内目录 | 说明 | +| -------------------------- | ----------------------------------------------------------- | +| `/app/static` | 图床中数据的存放路径，使用内置图床请务必映射好！ | +| `/var/log` | 日志的存放路径，包括 access 日志、 Caddy 日志和前台服务日志 | +| `/root/.config/caddy` | caddy 配置存储路径 | +| `/root/.local/share/caddy` | caddy 证书存储路径 | ## 站点配置 -请参考 ：[站点配置](/feature/basic/setting.md) +请参考：[站点配置](../feature/basic/setting.md) diff --git a/docs/ref/faq.md b/docs/ref/faq.md index 7166f4eae..43c8b0e06 100644 --- a/docs/ref/faq.md +++ b/docs/ref/faq.md @@ -7,7 +7,8 @@ icon: question VanBlog 目前处于快速迭代期，您可以先尝试参考升级指南进行升级，可能会解决一些问题： -[升级指南](/guide/update.md) +- [升级指南](../guide/update.md) + ::: ### 部署后无法访问后台 @@ -15,10 +16,10 @@ VanBlog 目前处于快速迭代期，您可以先尝试参考升级指南进行 可以按照下面的步骤简单排查一下： 0. 检查编排端口映射、配置是否正确。 -1. 看看容器日志，启动是否成功。 -2. 检查一下访问网址、端口是否正确。 -3. 检查一下服务器防火墙、云服务厂商防火墙是否放行。 -4. 检查一下本地服务器能不能访问。用 curl 简单测一下。 +1. 浏览容器日志，确认是否成功启动。 +2. 检查访问网址、端口是否正确。 +3. 检查服务器防火墙、云服务厂商防火墙是否放行。 +4. 检查本地服务器能不能访问。用 curl 简单测一下。 ### 后台编辑器主题颜色错乱 @@ -26,7 +27,7 @@ VanBlog 目前处于快速迭代期，您可以先尝试参考升级指南进行 ### 文章编辑器内容不对题 -这是浏览器内实时缓存导致的，编辑器会实时保存内容到浏览器的 LocalStorage，这个标识符是以 文章 id 为准的，如果你重装过或者迁移过，那么原来的文章 id 和现在文章 id 对应的内容是不同的，就会导致这个问题。 +这是浏览器内实时缓存导致的，编辑器会实时保存内容到浏览器的 LocalStorage，这个标识符是以 文章 ID 为准的，如果你重装过或者迁移过，那么原来的文章 ID 和现在文章 ID 对应的内容是不同的，就会导致这个问题。 解决办法很简单：在后台编辑器右上角的下拉菜单中手动点击清理该篇文章的缓存即可。 @@ -34,9 +35,13 @@ VanBlog 目前处于快速迭代期，您可以先尝试参考升级指南进行 使用宝塔内置的 nginx 反代后可能会出现一些问题：比如文章不更新等。 -之前有朋友也和我反馈了类似的问题。 经过排查是因为宝塔 nginx 本身的问题，他卸载了宝塔自带的 nginx ，然后手动安装了新版 nginx（通过系统的包管理器）后，解决了此问题。 +之前有朋友也和我反馈了类似的问题。经过排查是因为宝塔 nginx 本身的问题，他卸载了宝塔自带的 nginx ，然后手动安装了新版 nginx（通过系统的包管理器）后，解决了此问题。 + +::: note + +我怀疑宝塔 nginx 本身会在您自定义的配置文件外自动添加一些配置，或者是有一些专门为了宝塔面板做的客制化改造，导致了这个问题。 -PS: 我怀疑宝塔 nginx 本身会在您自定义的配置文件外自动添加一些配置，或者是有一些专门为了宝塔面板做的客制化改造，导致了这个问题。 +::: 如果还是没能解决可以去交流群里问我。 @@ -44,21 +49,19 @@ PS: 我怀疑宝塔 nginx 本身会在您自定义的配置文件外自动添加 改一下编排里的端口映射到非常用端口就好了。 -![](https://pic.mereith.com/img/47a03229d46e9120ad1e7bf1abf4b504.clipboard-2022-09-14.png) +![端口修改](https://pic.mereith.com/img/47a03229d46e9120ad1e7bf1abf4b504.clipboard-2022-09-14.png) ### docker 镜像拉取慢 -您可以设置一下 docker 镜像加速器： - -> [Docker 镜像加速](https://www.runoob.com/docker/docker-mirror-acceleration.html) +您可以 [设置 docker 镜像加速器](https://www.runoob.com/docker/docker-mirror-acceleration.html)。 ### 部署后 http error -![](https://pic.mereith.com/img/ae28e582a7dce7be4816c1bf82dd77de.clipboard-2022-08-28.png) +![错误案例](https://pic.mereith.com/img/ae28e582a7dce7be4816c1bf82dd77de.clipboard-2022-08-28.png) 请检查一下 docker-compose 编排文件，如果修改了下面的数据库账号密码，上面的也要同步修改。 -![](https://pic.mereith.com/img/eb46eabfff8856c84ccd54a97d7f333c.clipboard-2022-08-28.png) +![检查位置](https://pic.mereith.com/img/eb46eabfff8856c84ccd54a97d7f333c.clipboard-2022-08-28.png) 这两个地方的账号密码是对应的，实际上数据库是不会暴露到外面的（因为没有映射端口），所以默认账号密码不改也行。 @@ -74,7 +77,8 @@ PS: 我怀疑宝塔 nginx 本身会在您自定义的配置文件外自动添加 VanBlog 自 `v0.42.0` 已舍弃 `VAN_BLOG_ALLOW_DOMAINS` 环境变量，如果出现这个问题，推荐升级到最新版本以解决问题。 -[升级指南](/guide/update.md) +- [升级指南](../guide/update.md) + ::: 可能是没正确设置 `VAN_BLOG_ALLOW_DOMAINS` 这个环境变量导致的。 @@ -83,13 +87,13 @@ VanBlog 自 `v0.42.0` 已舍弃 `VAN_BLOG_ALLOW_DOMAINS` 环境变量，如果 比如用了 `xyx.com` 这个域名访问访问，那需要设置 `VAN_BLOG_ALLOW_DOMAINS` 为 `xyz.com`，比如用了 `localhost` 访问，那需要设置为 `localhost`，如果多个域名用英文逗号分隔，不支持通配符。 -请参考 [启动配置](/ref/env.md#环境变量) +请参考 [启动配置](./env.md#环境变量) ### 在编辑器复制后格式错乱 -默认粘贴的格式可能带有一些额外信息，你可以鼠标右键选择复制为纯文本，或者使用快捷键 `ctrl+shift+v` 。 +默认粘贴的格式可能带有一些额外信息，你可以鼠标右键选择复制为纯文本，或者使用快捷键 Ctrl + Shift + V。 -![](https://pic.mereith.com/img/88b29bad4ad0ef7d6e411e43f80ec1bc.clipboard-2022-08-22.png) +![粘贴示例](https://pic.mereith.com/img/88b29bad4ad0ef7d6e411e43f80ec1bc.clipboard-2022-08-22.png) ### 升级之后文章都没了 @@ -105,11 +109,11 @@ VanBlog 自 `v0.42.0` 已舍弃 `VAN_BLOG_ALLOW_DOMAINS` 环境变量，如果 ### 我觉得太丑了||可以自定义样式吗？ -可以！请参考 [客制化功能](/feature/advance/customizing.md) +可以！请参考 [客制化功能](../feature/advance/customizing.md) ### 自定义页面 -现在已经可以自定义页面了！请参考 [自定义页面](/feature/advance/customPage.md) +现在已经可以自定义页面了！请参考 [自定义页面](../feature/advance/customPage.md) ### 如何安装 docker ? @@ -133,11 +137,11 @@ curl -sSL https://get.daocloud.io/docker | sh 如果你想连接的话，首先需要修改编排中 mongoDB 的账密（对外暴漏端口有安全风险，一定要设置强密码！） -![](https://www.mereith.com/static/img/06f19fe68043cd4e8780e1e2484b70d9.clipboard-2022-09-02.png) +![修改账号密码](https://www.mereith.com/static/img/06f19fe68043cd4e8780e1e2484b70d9.clipboard-2022-09-02.png) 注意画红圈的地方要同步改，然后加上下图画红线的语句： -![](https://www.mereith.com/static/img/e2bc119c1408d50f73a2da526dec96c8.clipboard-2022-09-02.png) +![添加端口](https://www.mereith.com/static/img/e2bc119c1408d50f73a2da526dec96c8.clipboard-2022-09-02.png) 然后运行 `docker-compose down -v && docker-compose up -d` 重启容器，就可以通过 27017 端口访问 mongoDB 了。 @@ -155,7 +159,7 @@ docker-compose down -v && docker-compose up -d ### https 反代前台点击按钮跳转后页面不更新 -参考其他人的经验，用宝塔 + nginx 可能会出现这个问题，这时可以尝试升级一下 nginx 版本应该能得到解决。 +参考其他人的经验，用 宝塔 + nginx 可能会出现这个问题，这时可以尝试升级一下 nginx 版本应该能得到解决。 ### Bug 反馈 diff --git a/docs/ref/log.md b/docs/ref/log.md index 509eea926..3f276e7db 100644 --- a/docs/ref/log.md +++ b/docs/ref/log.md @@ -5,16 +5,12 @@ icon: blog `VanBlog` 现在已上线登录日志，可以在后台日志管理中查看。 -![](https://pic.mereith.com/img/aeeba490d260f60e57d584837c31ba3b.clipboard-2022-08-23.png) +![日志管理](https://pic.mereith.com/img/aeeba490d260f60e57d584837c31ba3b.clipboard-2022-08-23.png) 所有日志在容器内的位置如下： -> access 日志： /var/log/vanblog-access.log -> -> caddy 运行日志: /var/log/caddy.log -> -> 前台构建器运行日志: /var/log/vanblog-website.log -> -> 审计日志（目前只有登录）日志: /var/log/vanblog-event.log -> -> API 服务器运行日志: stdout +- access 日志： `/var/log/vanblog-access.log` +- caddy 运行日志: `/var/log/caddy.log` +- 前台构建器运行日志: `/var/log/vanblog-website.log` +- 审计日志（目前只有登录）日志: `/var/log/vanblog-event.log` +- API 服务器运行日志: `stdout`