docs: update guide and fix typos

README.md

@@ -103,7 +103,7 @@ curl -L https://vanblog.mereith.com/vanblog.sh -o vanblog.sh && chmod +x vanblog
 
 ## 交流群
 
-- [VanBlog  交流群](https://jq.qq.com/?_wv=1027&k=5NRyK2Sw)
+- [VanBlog 交流群](https://jq.qq.com/?_wv=1027&k=5NRyK2Sw)
 
 ## 说明与文档
 

docs/.vuepress/theme.ts

@@ -43,6 +43,7 @@ export default hopeTheme({
 
     mdEnhance: {
       align: true,
+      codetabs: true,
       figure: true,
       imgLazyload: true,
       tasklist: true,

docs/guide/backup.md

@@ -4,17 +4,17 @@ title: 备份与迁移
 copyright: false
 ---
 
-想要备份或迁移 `vanblog` ，参考如下（方法还有很多，有效即可）：
+想要备份或迁移 VanBlog ，参考如下（方法还有很多，有效即可）。
 
 ## 备份/迁移持久化目录
 
-因为 `vanblog` 本质上是通过 `docker` 部署的，所以只要迁移映射到宿主机的持久化目录到新机器上就好啦！
+因为 VanBlog 本质上是通过 `docker` 部署的，所以只要迁移映射到宿主机的持久化目录到新机器上就好啦！
 
-这种方式最无感，因为 `vanblog` 容器所有的状态都在持久化目录中了，迁移了他们，对于 `vanblog` 服务来说，就是无感的。备份同理。
+这种方式最无感，因为 VanBlog 容器所有的状态都在持久化目录中了，迁移了它们，对于 VanBlog 服务来说，就是无感的；备份同理。
 
 ### 对于一键脚本部署
 
-迁移 `/var/vanblog` 目录到新机器，然后用`一件脚本重启服务`就好了。
+迁移 `/var/vanblog` 目录到新机器，然后用 `一键脚本重启服务` 就好了。
 
 ```bash
 # 打包老机器的文件夹
@@ -29,7 +29,7 @@ curl -L https://vanblog.mereith.com/vanblog.sh -o vanblog.sh && chmod +x vanblog
 
 ## 导入导出功能
 
-`vanblog` 后台内置有[导入导出](/feature/advance/backup.md)功能，可以通过此功能实现备份。但有一些局限：
+VanBlog 后台内置有 [导入导出](../feature/advance/backup.md)功能，可以通过此功能实现备份。但有一些局限：
 
 - 无法备份内置图床的数据。
 - 无法备份自定义文件夹页面点数据。

docs/guide/docker.md

@@ -12,6 +12,7 @@ VanBlog 是一款简洁实用优雅的高性能个人博客系统。支持黑暗
 你也可以先查看 [Demo](https://blog-demo.mereith.com)，账号密码均为 `demo`
 
 目前 VanBlog 还在快速迭代中，如果后台出现升级提示，推荐进行升级。
+
 :::
 
 欢迎使用 VanBlog ，只需几个步骤，你就可以在你的服务器搭建自己的博客服务了。
@@ -22,11 +23,11 @@ VanBlog 是一款简洁实用优雅的高性能个人博客系统。支持黑暗
 
 理论上 `VanBlog` 不需要很高的配置，实际上演示站不算数据库，资源的占用情况如图：
 
-![](https://www.mereith.com/static/img/bd2a2c983aa92288106652294a892494.clipboard-2022-09-03.png)
+![资源占用](https://www.mereith.com/static/img/bd2a2c983aa92288106652294a892494.clipboard-2022-09-03.png)
 
 不到 `400M` 的内存（有一部分还是静态页面缓存），启动时大概峰值占用处理器一个核心的 `30%`，其余时间基本不占用什么处理器资源。
 
-但比较小的带宽可能会让页面加载变慢（第一次慢，后面的话有缓存加速就会快一些），如果带宽比较小的话可以尝试设置一下 [CDN](/ref/faq.md#%E5%A6%82%E4%BD%95%E9%83%A8%E7%BD%B2%E5%88%B0%20CDN)。
+但比较小的带宽可能会让页面加载变慢（第一次慢，后面的话有缓存加速就会快一些），如果带宽比较小的话可以尝试设置一下 [CDN](../ref/faq.md#%E5%A6%82%E4%BD%95%E9%83%A8%E7%BD%B2%E5%88%B0%20CDN)。
 
 ## 部署方式
 
@@ -38,16 +39,18 @@ VanBlog 是一款简洁实用优雅的高性能个人博客系统。支持黑暗
 
 ## 一键脚本部署
 
-::: info VanBlog
 现在可以使用一键脚本来部署 VanBlog 啦！刚开发完试运行中，有问题请及时反馈！
 
+::: tip
+
 只推荐在纯 linux 环境下使用此脚本，宝塔上也可以用，但我没有广泛测过，如有问题请反馈！
 
-群晖部署请参考： [群晖部署教程](/ref/dsm.md)
+群晖部署请参考： [群晖部署教程](../ref/dsm.md)
 
 各位反代的同学，不要管什么 Caddy ，就当他不存在！VanBlog 是一个整体，反代你映射的 http 端口就好了！
 
-需要反代请前往： [反代配置](/guide/nginx.md)
+需要反代请前往： [反代配置](./nginx.md)
+
 :::
 
 输入以下命令即可：
@@ -62,15 +65,15 @@ curl -L https://vanblog.mereith.com/vanblog.sh -o vanblog.sh && chmod +x vanblog
 ./vanblog.sh
 ```
 
-![](https://pic.mereith.com/img/fbbf5dde011f9dec13cdb25ad741765f.clipboard-2022-09-20.png)
+![脚本演示](https://pic.mereith.com/img/fbbf5dde011f9dec13cdb25ad741765f.clipboard-2022-09-20.png)
 
-浏览器打开 `http://<你的域名>/admin/init` ，并按照提示初始化即可。具体设置项可以参考 [站点配置](/feature/basic/setting.md)
+浏览器打开 `http://<你的域名>/admin/init` ，并按照提示初始化即可。具体设置项可以参考 [站点配置](../feature/basic/setting.md)
 
 也可以在前台点击右上角管理员按钮即可进入后台初始化页面。
 
-> 如果你想在外部访问数据库，请参考 [常见问题](/guide/faq.md) 中的 `如何从外部访问数据库`
+> 如果你想在外部访问数据库，请参考 [常见问题](./faq.md) 中的 `如何从外部访问数据库`
 >
-> 如果你想反代请参考 [反代](/guide/nginx.md)
+> 如果你想反代请参考 [反代](./nginx.md)
 
 ## docker-compose 部署
 
@@ -137,7 +140,7 @@ services:
 
 ### 3.启动项目
 
-按注释说明修改`docker-compose.yml`的配置后运行：
+按注释说明修改 `docker-compose.yml` 的配置后运行：
 
 ```bash
 docker-compose up -d
@@ -147,16 +150,18 @@ docker-compose up -d
 
 也可以在前台点击右上角管理员按钮即可进入后台初始化页面。
 
-> 如果你想在外部访问数据库，请参考 [常见问题](/guide/faq.md) 中的 `如何从外部访问数据库`
+> 如果你想在外部访问数据库，请参考 [常见问题](./faq.md) 中的 `如何从外部访问数据库`
 >
-> 如果你想反代请参考 [反代](/guide/nginx.md)
+> 如果你想反代请参考 [反代](./nginx.md)
+
+::: info HTTPS
 
-::: info VanBlog
 首次运行默认是关闭 `https` 的，请通过 `http` 协议访问。初始化后，进入后台确认 https 证书已自动生成后可选择开启 https 自动重定向。
 
 无论 `HTTPS 自动重定向` 是否开启，都暂不支持通过 `https + ip 地址` 来访问。需要 ip 访问请用 `http` 协议并关闭 https 自动重定向。
 
-具体请参考： [HTTPS](/guide/https.md)
+具体请参考： [HTTPS](./https.md)
+
 :::
 
 ## kubernetes
@@ -228,11 +233,11 @@ spec:
 
 ## 宝塔面板部署
 
-请移步 [通过宝塔面板部署 VanBlog](/ref/baota.md)
+请移步 [通过宝塔面板部署 VanBlog](../ref/baota.md)
 
 ## 群晖部署
 
-请移步 [群晖部署 VanBlog](/ref/dsm.md)
+请移步 [群晖部署 VanBlog](../ref/dsm.md)
 
 ## 直接部署
 
@@ -300,7 +305,7 @@ yarn
 
 #### 运行后端
 
-```
+```bash
 # 切换目录
 cd packages/server
 # 安装依赖
@@ -322,7 +327,7 @@ waline:
 
 然后按照自己的方法把下面的命令运行到后台:
 
-```
+```bash
 # 必须在 packages/server 目录下运行
 yarn start
 ```
@@ -351,6 +356,6 @@ caddy start --config ./Caddyfile
 
 #### 完成
 
-浏览器打开 `http://<你的域名>/admin/init` ，并按照提示初始化即可。具体设置项可以参考 [站点配置](/feature/basic/setting.md)
+浏览器打开 `http://<你的域名>/admin/init` ，并按照提示初始化即可。具体设置项可以参考 [站点配置](../feature/basic/setting.md)
 
 也可以在前台点击右上角管理员按钮即可进入后台初始化页面。

docs/guide/faq.md

@@ -7,7 +7,8 @@ icon: question
 
 VanBlog 目前处于快速迭代期，您可以先尝试参考升级指南进行升级，可能会解决一些问题：
 
-[升级指南](/guide/update.md)
+- [升级指南](../guide/update.md)
+
 :::
 
 ### 部署后无法访问后台
@@ -44,13 +45,11 @@ 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
 

docs/guide/head.md

@@ -20,11 +20,11 @@ order: -1
 
 ## 1. 云服务器
 
-::: info VanBlog
+<!-- ::: info VanBlog
 
 如果不懂什么是云服务器，可以看这篇文章：
 
-:::
+::: -->
 
 ### 要求
 
@@ -44,12 +44,11 @@ order: -1
 
 我一般用腾讯云的（相对便宜 2333）直达链接：
 
-【腾讯云】多款云产品 1 折起，买云服务器送免费机器，最长免费续 3 个月
-https://cloud.tencent.com/act/cps/redirect?redirect=2446&cps_key=a3b2d0c73d758078529ef6f11c73ddde&from=console
+- [【腾讯云】多款云产品 1 折起，买云服务器送免费机器，最长免费续 3 个月](https://cloud.tencent.com/act/cps/redirect?redirect=2446&cps_key=a3b2d0c73d758078529ef6f11c73ddde&from=console)
 
 买最便宜的 72 一年的 2 核 4G4M 的就行。
 
-![](https://pic.mereith.com/img/a7cee9afd60618a5ddee72d1c0916dfa.clipboard-2022-08-26.png)
+![购买内容](https://pic.mereith.com/img/a7cee9afd60618a5ddee72d1c0916dfa.clipboard-2022-08-26.png)
 
 购买之后系统可以选择你熟悉的 `linux` 发行版，如果没有，可以选择 `Ubuntu Server 20.04 LTS 64bit`。
 
@@ -63,7 +62,7 @@ https://cloud.tencent.com/act/cps/redirect?redirect=2446&cps_key=a3b2d0c73d75807
 
 如果找不到，直接在云厂商搜索 `备案`。
 
-![](https://pic.mereith.com/img/7eb6914370aa7f2912ce565894c657d7.clipboard-2022-08-26.png)
+![网站备案](https://pic.mereith.com/img/7eb6914370aa7f2912ce565894c657d7.clipboard-2022-08-26.png)
 
 ## 2. 域名
 

docs/guide/https.md

@@ -23,7 +23,7 @@ order: -3
 
 首次运行时默认关闭了 `https 自动重定向` ，请在初始化后进入后台的 `站点管理/系统设置/ HTTPS` 中设置确认 `https` 状态后再按需开启 `https 自动重定向`
 
-![](https://pic.mereith.com/img/d1e7b502279f0bd8225dfaedf89a5140.clipboard-2022-08-23.png)
+![开启 https 自动重定向](https://pic.mereith.com/img/d1e7b502279f0bd8225dfaedf89a5140.clipboard-2022-08-23.png)
 
 ## 自动 HTTPS 要求
 
@@ -41,13 +41,13 @@ order: -3
 
 注意的是只有域名可以，通过 `ip` 访问是不会触发自动申请证书的。
 
-![](https://pic.mereith.com/img/8383fb4f32144be26cb134c2390d6d10.clipboard-2022-08-23.png)
+![申请证书](https://pic.mereith.com/img/8383fb4f32144be26cb134c2390d6d10.clipboard-2022-08-23.png)
 
 ## https 自动重定向
 
 当你确保可以通过自动申请的证书正常访问的时候，可以选择开启 `https 自动重定向` 功能，开启后所有的 `http` 访问将自动重定向到 `https`。
 
-但是开启后，也不可以通过 `https+ip` 访问本站了，所以一定要确认后再开启。
+但是开启后，也不可以通过 `https + ip` 访问本站了，所以一定要确认后再开启。
 
 这个配置将会保存到数据库，每次容器启动的时候都会初始化到 `Caddy` 中。
 

docs/guide/init.md

@@ -5,11 +5,11 @@ copyright: false
 order: -2
 ---
 
-部署`vanBlog`后，浏览器打开 `http://<your-ip>/admin/init` 将会展示初始化页面。具体设置项可以参考 [站点配置](/feature/basic/setting.md)。
+部署 `vanBlog` 后，浏览器打开 `http://<your-ip>/admin/init` 将会展示初始化页面。具体设置项可以参考 [站点配置](../feature/basic/setting.md)。
 
 也可以在前台点击右上角管理员按钮即可进入后台初始化页面。
 
-![](https://pic.mereith.com/img/c088fa93f4e7aeab33dac821d1dc7dc5.clipboard-2022-08-16.png)
+![初始化指引](https://pic.mereith.com/img/c088fa93f4e7aeab33dac821d1dc7dc5.clipboard-2022-08-16.png)
 
 具体分为四部分：
 
@@ -18,4 +18,4 @@ order: -2
 - 高级配置: 可选，用于开启一些高级功能
 - 布局配置: 可选，配置前台布局
 
-具体设置项可以参考 [站点配置](/feature/basic/setting.md)。
+具体设置项可以参考 [站点配置](../feature/basic/setting.md)。

docs/guide/nginx.md

@@ -7,11 +7,11 @@ order: -3
 
 :::info 注意
 
-vanblog 内置了 caddy，可以全自动申请 https 证书，如没有其他服务需要共存，是不建议再加一层反代的。
+VanBlog 内置了 caddy，可以全自动申请 https 证书，如没有其他服务需要共存，是不建议再加一层反代的。
 
 使用反向代理之前记得要按需修改默认的 80 端口号哦。如果你要反代，请不要开启 `https 自动重定向` (默认是关闭的)
 
-另外很多人会被内置的 Caddy 搞蒙，你完全不用考虑什么 Caddy，你就当它不存在，把整个 Vanblog 当作一个整体，去反代映射出去的 http 端口就好了。
+另外很多人会被内置的 Caddy 搞蒙，你完全不用考虑什么 Caddy，你就当它不存在，把整个 VanBlog 当作一个整体，去反代映射出去的 http 端口就好了。
 
 各位反代的同学，不要管什么 Caddy ，就当他不存在！VanBlog 是一个整体，反代你映射的 http 端口就好了！
 :::
@@ -24,9 +24,13 @@ vanblog 内置了 caddy，可以全自动申请 https 证书，如没有其他
 
 第二推荐的是 [caddy](https://caddyserver.com/)，一个现代的高性能 web 服务器，它也可以自动帮你配置好 `https`
 
-配置文件参考（caddy v2）：
+配置文件参考：
 
-```
+::: code-tabs
+
+@tab Caddy V2
+
+```conf
 example.com {
   tls admin@example.com
   reverse_proxy  127.0.0.1:<你映射的端口号> {
@@ -35,19 +39,20 @@ example.com {
 }
 ```
 
-caddy v1:
+@tab Caddy V1
 
-```
+```conf
 example.com {
   tls admin@example.com
   proxy / 127.0.0.1:<你映射的端口号> {
     transparent
     websocket
   }
 }
-
 ```
 
+:::
+
 ### nginx
 
 如果你还是想想用 nginx 的话，那好吧。安利一个 nginx 配置在线生成工具： [https://nginxconfig.io/](https://nginxconfig.io/)
@@ -56,9 +61,12 @@ example.com {
 
 - 宝塔面板用 nginx 反代，如果出现问题，可以去升级一下 nginx 版本，有可能会解决问题。
 - location 下面的配置块只保留下面提供配置的那几行就可以了，不要加奇奇怪怪的语句和请求头（看不懂请忽略）
-  :::
 
-http 版本的：
+:::
+
+::: code-tabs
+
+@tab Http
 
 ```nginx
 server {
@@ -73,6 +81,7 @@ server {
   server_name example.com;
   proxy_buffers 8 32k;
   proxy_buffer_size 64k;
+
   location / {
     # 改为容器的 PORT
     proxy_pass http://127.0.0.1:<PORT>;
@@ -83,18 +92,17 @@ server {
 }
 ```
 
-https 版本的：
+@tab Https
 
 ```nginx
-
 server {
   listen 80;
   # 改为你的网址
   server_name example.com;
   # 重定向为 https
   return 301 https://$host$request_uri;
-
 }
+
 server {
   listen 443 ssl http2;
   # 改为你的网址
@@ -110,6 +118,7 @@ server {
     proxy_set_header X-Forwarded-Proto $scheme;
     proxy_set_header Upgrade $http_upgrade;
   }
-
 }
 ```
+
+:::