Merge remote-tracking branch 'origin/docs-update' into docs-update

.vscode/settings.json

@@ -6,5 +6,8 @@
     "tsconfig.json": "json5",
     "tsconfig.*.json": "json5",
   },
+  "[markdown]": {
+    "editor.wordWrap": "off",
+  },
   "python.venvPath": "./backend/venv",
 }

docs/.vitepress/config.ts

@@ -13,6 +13,10 @@ export default defineConfig({
       { text: "常见问题", link: "/faq/常见问题" },
     ],
 
+    search: {
+      provider: 'local'
+    },
+
     sidebar: [
       {
         text: "项目说明",

docs/.vitepress/theme/index.ts

@@ -1,6 +1,14 @@
 // https://vitepress.dev/guide/custom-theme
-import { h } from 'vue'
+import { 
+  h, 
+  onMounted, 
+  watch, 
+  nextTick,
+} from 'vue'
 import Theme from 'vitepress/theme'
+import { useRoute } from 'vitepress'
+import mediumZoom from 'medium-zoom'
+
 import './style.css'
 
 export default {
@@ -10,6 +18,25 @@ export default {
       // https://vitepress.dev/guide/extending-default-theme#layout-slots
     })
   },
+  setup() {
+    const route = useRoute()
+    const initZoom = () => {
+      /**
+       * Allow images to be zoomed in on click 
+       * https://github.com/vuejs/vitepress/issues/854
+       */
+      mediumZoom('[data-zoomable]', { background: 'var(--vp-c-bg)' })
+    }
+    
+    onMounted(() => {
+      initZoom()
+    })
+
+    watch(
+      () => route.path,
+      () => nextTick(initZoom),
+    )
+  },
   enhanceApp({ app, router, siteData }) {
     // ...
   }

docs/.vitepress/theme/style.css

@@ -89,3 +89,14 @@
   --docsearch-primary-color: var(--vp-c-brand) !important;
 }
 
+/**
+ * Component: medium-zoom
+ * -------------------------------------------------------------------------- */
+
+.medium-zoom-overlay {
+  z-index: 20;
+}
+
+.medium-zoom-image {
+  z-index: 21;
+}

docs/config/rss.md

@@ -11,7 +11,7 @@ AutoBangumi 可以自动解析 [Mikan Project][mikan-site] 的 RSS 订阅地址
 
 本项目基于解析 Mikan Project 提供的 RSS 地址，因此如果要实现自动追番，需要注册并且获得 Mikan Project 的 RSS 地址：
 
-![image](../image/rss/rss-token.png)
+![image](../image/rss/rss-token.png){data-zoomable}
 
 获取的 RSS 地址如下：
 
@@ -27,7 +27,7 @@ AB 中需要填入的 `token` 为以上 url 中 `token=` 后面的一串字符
 
 由于 AutoBangumi 会解析所有获得的 RSS 信息，因此在订阅番剧的时候需要注意以下几点：
 
-![image](../image/rss/advanced-subscription.png)
+![image](../image/rss/advanced-subscription.png){data-zoomable}
 
 - 在个人设置中打开高级设置。
 - 一部番剧只订阅一个字幕组，点击 Mikan Project 的番剧图片即可呼出二级菜单，选择一个字幕组订阅即可。

docs/deploy/dsm.md

@@ -9,13 +9,13 @@
 
 进入套件中心，安装 Container Manager (Docker) 套件。
 
-![install-docker](../image/dsm/install-docker.png)
+![install-docker](../image/dsm/install-docker.png){data-zoomable}
 
 ## 通过 Docker compose 安装配置 AB
 
 点击 **项目**，然后点击 **新建**，选择 **Docker Compose**。
 
-![new-compose](../image/dsm/new-compose.png)
+![new-compose](../image/dsm/new-compose.png){data-zoomable}
 
 复制以下内容填入 **Docker Compose** 中。
 ```yaml
@@ -36,7 +36,7 @@ services:
 
 点击 **下一步**，然后点击 **完成**。
 
-![create](../image/dsm/create.png)
+![create](../image/dsm/create.png){data-zoomable}
 
 完成创建之后进入 `http://<NAS IP>:7892` 即可进入 AB 并进行配置。
 

docs/home/index.md

@@ -11,7 +11,13 @@
 
 
 <p align="center">
-  <img title="AutoBangumi" src="../image/window.png" alt="" width=75%>
+  <img
+    title="AutoBangumi WebUI"
+    alt="AutoBangumi WebUI"
+    src="../image/window.png"
+    width=75%
+    data-zoomable
+  >
 </p>
 
 本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。

docs/package.json

@@ -7,6 +7,7 @@
     "deploy:preview": "vercel --cwd .vitepress/dist"
   },
   "devDependencies": {
+    "medium-zoom": "^1.0.8",
     "typescript": "4.9.5",
     "vercel": "31.0.1",
     "vitepress": "1.0.0-beta.3",

docs/pnpm-lock.yaml

@@ -1,6 +1,9 @@
 lockfileVersion: '6.0'
 
 devDependencies:
+  medium-zoom:
+    specifier: ^1.0.8
+    version: 1.0.8
   typescript:
     specifier: 4.9.5
     version: 4.9.5
@@ -4922,6 +4925,10 @@ packages:
     engines: {node: '>= 0.6'}
     dev: true
 
+  /medium-zoom@1.0.8:
+    resolution: {integrity: sha512-CjFVuFq/IfrdqesAXfg+hzlDKu6A2n80ZIq0Kl9kWjoHh9j1N9Uvk5X0/MmN0hOfm5F9YBswlClhcwnmtwz7gA==}
+    dev: true
+
   /merge-descriptors@1.0.1:
     resolution: {integrity: sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w==}
     dev: true