docs: refactor, update docs to 3.0

2026-04-05 03:29:22 +08:00 · 2023-07-06 22:15:28 +08:00
parent 2e0a66f566
commit 8622ed3afd
31 changed files with 368 additions and 211 deletions
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -8,7 +8,7 @@ export default defineConfig({
    // https://vitepress.dev/reference/default-theme-config
    nav: [
      { text: "项目说明", link: "/home/" },
-      { text: "开始部署", link: "/deploy/部署说明" },
+      { text: "快速开始", link: "/deploy/quick-start" },
      { text: "排错流程", link: "/faq/排错流程" },
      { text: "常见问题", link: "/faq/常见问题" },
    ],
@@ -26,21 +26,17 @@ export default defineConfig({
      {
        text: "部署",
        items: [
-          {
-            text: "部署前准备",
-            link: "/deploy/部署说明",
-          },
          {
            text: "Docker-cli 部署",
-            link: "/deploy/Docker-cli",
+            link: "/deploy/docker-cli",
          },
          {
            text: "Docker-Compose 部署",
-            link: "/deploy/Docker-compose",
+            link: "/deploy/docker-compose",
          },
          {
            text: "群晖NAS",
-            link: "/deploy/群晖",
+            link: "/deploy/dsm",
          },
          {
            text: "WSL",
@@ -53,26 +49,42 @@ export default defineConfig({
        items: [
          {
            text: "Windows 本地部署",
-            link: "/deploy/Windows-本地部署",
+            link: "/deploy/windows",
          },
          {
            text: "Unix 本地部署",
-            link: "/deploy/local-run",
+            link: "/deploy/unix",
          },
        ],
      },
      {
-        text: "使用说明",
+        text: "配置说明",
        items: [
-          {
-            text: "使用说明",
-            link: "/use/使用说明",
-          },
-          {
-            text: "配置选项说明",
-            link: "/use/配置选项说明",
-          },
-        ],
+            {
+                text: "获取 RSS 订阅链接",
+                link: "/config/rss",
+            },
+            {
+              text: "主程序配置",
+              link: "/config/program",
+            },
+            {
+                text: "下载器配置",
+                link: "/config/downloader",
+            },
+            {
+                text: "解析器配置",
+                link: "/config/parser",
+            },
+            {
+                text: "推送器配置",
+                link: "/config/notifier",
+            },
+            {
+                text: "代理配置",
+                link: "/config/proxy",
+            }
+            ]
      },
      {
        text: "FAQ",
--- a/docs/changelog/2.6.md
+++ b/docs/changelog/2.6.md
@@ -125,7 +125,7 @@ AB 现在可以对合集以及文件夹内的文件进行重命名了，此时 A

 **标准路径**
    
-```text
+```
 /downloads/Bangumi/剧集信息/Season 1/xxx
 ```

--- a/docs/config/downloader.md
+++ b/docs/config/downloader.md
@@ -0,0 +1,25 @@
+# 下载器设置
+
+## WebUI 设置
+
+![downloader](../image/config/downloader.png)
+
+- `type` 为下载器类型，目前支持 `qbittorrent` 下载器，目前暂不支持修改。
+- `host` 为下载器地址。[下载器链接问题][1]
+- `path` 为映射的下载器下载路径。[下载器路径问题][2]
+- `ssl` 为下载器是否使用 SSL。
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`downloader`
+
+| 参数名      | 参数说明        | 参数类型 | WebUI 对应选项  | 默认值                |
+|----------|-------------|------|-------------|--------------------|
+| type     | 下载器类型       | 字符串  | 下载器类型       | qbittorrent        |
+| host     | 下载器地址       | 字符串  | 下载器地址       | 172.17.0.1:8080    |
+| username | 下载器用户名      | 字符串  | 下载器用户名      | admin              |
+| password | 下载器密码       | 字符串  | 下载器密码       | adminadmin         |
+| path     | 下载器下载路径     | 字符串  | 下载器下载路径     | /downloads/Bangumi |
+| ssl      | 下载器是否使用 SSL | 布尔值  | 下载器是否使用 SSL | false              |
--- a/docs/config/notifier.md
+++ b/docs/config/notifier.md
@@ -0,0 +1,25 @@
+# 通知配置
+
+## WebUI 配置
+
+![notification](../image/config/notifier.png)
+
+- `type` 为通知类型，目前支持 `telegram` 、 `serverchan` 、 `bark`、 `wecom` 四种类型。
+- `token` 为通知 Token，目前支持 `telegram` 、 `serverchan` 、 `bark`、 `wecom` 四种类型。
+- `chat_id` 为通知 Chat ID，仅在使用 `telegram` 通知时需要填写。[Telegram Bot 获取 Chat ID][5]
+- 使用`wecom`时，chat_id参数框填写自建推送的url地址，同时需要在服务端增加[图文消息][6]类型。[Wecom酱配置说明][7]
+
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`notification`
+
+| 参数名     | 参数说明       | 参数类型 | WebUI 对应选项 | 默认值      |
+|---------|------------|------|------------|----------|
+| enable  | 是否启用通知     | 布尔值  | 通知         | false    |
+| type    | 通知类型       | 字符串  | 通知类型       | telegram |
+| token   | 通知 Token   | 字符串  | 通知 Token   |
+| chat_id | 通知 Chat ID | 字符串  | 通知 Chat ID |
+
--- a/docs/config/parser.md
+++ b/docs/config/parser.md
@@ -0,0 +1,39 @@
+# 解析器设置
+
+AB 的解析器用于解析聚合 RSS 链接，如果 RSS 有新条目更新，AB 就会解析标题并且生成自动下载规则。
+
+## Webui 中的解析器设置
+
+![parser](../image/config/parser.png)
+
+- Enable: 是否启用 RSS 解析器。
+- Source 为 RSS 解析器类型，目前支持 `mikan` 。
+- Token 为蜜柑计划的 Token。[蜜柑计划 Token 获取][rss_token]
+- Custom_url 为自定义蜜柑计划地址。[自定义反代地址][reproxy]
+- Language 为 RSS 解析器语言，目前支持 `zh` 、 `jp` 、 `en` 三种语言。
+- Parser_type 为 **官方标题** 解析器解析类型，支持类型如下：
+  - parser 为正则表达式解析器，使用正则表达式解析标题。
+  - mikan 为蜜柑计划解析器，使用蜜柑计划解析标题。
+  - tmdb 为 TMDB 解析器，使用 TMDB 解析标题。
+- Exclude 为全局 RSS 解析器过滤器，可以填入字符串或者正则表达式，AB 在解析 RSS 时会过滤掉符合过滤器的条目。
+
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`rss_parser`
+
+| 参数名         | 参数说明           | 参数类型 | WebUI 对应选项     | 默认值           |
+|-------------|----------------|------|----------------|---------------|
+| enable      | RSS 解析器是否启用    | 布尔值  | RSS 解析器是否启用    | true          |
+| type        | RSS 解析器类型      | 字符串  | RSS 解析器类型      | mikan         |
+| token       | RSS 解析器 Token  | 字符串  | RSS 解析器 Token  | token         |
+| custom_url  | RSS 解析器自定义 URL | 字符串  | RSS 解析器自定义 URL | mikanime.tv   |
+| parser_type | RSS 解析器解析类型    | 字符串  | RSS 解析器解析类型    | parser        |
+| filter      | RSS 解析器过滤器     | 数组   | 过滤器            | [720,\d+-\d+] |
+| language    | RSS 解析器语言      | 字符串  | RSS 解析器语言      | zh            |
+
+
+[rss_token]: rss
+[reproxy]: proxy##反向代理设置
--- a/docs/config/program.md
+++ b/docs/config/program.md
@@ -0,0 +1,23 @@
+# 主程序运行配置
+
+## WebUI 配置
+
+![program](../image/config/program.png)
+
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`program`
+
+| 参数名         | 参数说明       | 参数类型     | WebUI 对应选项 | 默认值  |
+|-------------|------------|----------|------------|------|
+| rss_time    | RSS 检查时间间隔 | 以秒为单位的整数 | RSS 检查时间间隔 | 7200 |
+| rename_time | 重命名检查时间间隔  | 以秒为单位的整数 | 重命名检查时间间隔  | 60   |
+| webui_port  | WebUI 端口   | 以整数为单位   | WebUI 端口   | 7892 |
+
+- `rss_time` 和 `rename_time` 两个参数的单位为秒，如果你需要设置为分钟，请自行转换为秒。
+- `rss_time` 为 RSS 检查时间间隔，如果你需要修改 RSS 检查时间间隔，请修改此参数。
+- `rename_time` 为重命名检查时间间隔，如果你需要修改重命名检查时间间隔，请修改此参数。
+- `webui_port` 为 WebUI 端口，如果你需要修改 WebUI 端口，请修改此参数。
--- a/docs/config/proxy.md
+++ b/docs/config/proxy.md
@@ -0,0 +1,28 @@
+# 代理和反向代理
+
+AB 支持 HTTP 代理和 SOCKS5 代理，通过设置代理可以解决一些网络问题。
+
+## 代理
+
+
+## 反向代理设置
+
+
+## `config.json` 中的配置选项
+
+在配置文件中对应选项如下：
+
+配置文件部分：`proxy`
+
+| 参数名      | 参数说明   | 参数类型 | WebUI 对应选项 | 默认值   |
+|----------|--------|------|------------|-------|
+| enable   | 是否启用代理 | 布尔值  | 代理         | false |
+| type     | 代理类型   | 字符串  | 代理类型       | http  |
+| host     | 代理地址   | 字符串  | 代理地址       |
+| port     | 代理端口   | 整数   | 代理端口       |
+| username | 代理用户名  | 字符串  | 代理用户名      |
+| password | 代理密码   | 字符串  | 代理密码       |
+
+
+- `type` 为代理类型，目前支持 `http` 、 `socks5` 两种类型。
+- `username` 与 `password` 仅支持 `socks5` 代理。
--- a/docs/config/rss.md
+++ b/docs/config/rss.md
@@ -0,0 +1,36 @@
+# 准备 Mikan RSS 订阅链接
+
+AutoBangumi 可以自动解析 [Mikan Project][mikan-site] 的 RSS 订阅地址，根据字幕组以及番剧名称生成下载规则， 从而实现自动追番。
+因此在开始自动追番之前，你需要准备好 [Mikan Project][mikan-site] 的 RSS 订阅地址。
+
+需要注意的是，目前 Mikan Project 主站已经被墙，当你不知道如何使用代理时请使用如下链接进行访问订阅：
+
+[Mikan Project CN][mikan-cn-site]
+
+## 获取订阅地址
+
+本项目基于解析 Mikan Project 提供的 RSS 地址，因此如果要实现自动追番，需要注册并且获得 Mikan Project 的 RSS 地址：
+
+![image](../image/rss/rss-token.png)
+
+获取的 RSS 地址如下：
+
+```txt
+https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+# 或者
+https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+```
+
+AB 中需要填入的 `token` 为以上 url 中 `token=` 后面的一串字符。
+
+## Mikan Project 订阅贴士
+
+由于 AutoBangumi 会解析所有获得的 RSS 信息，因此在订阅番剧的时候需要注意以下几点：
+
+![image](../image/rss/advanced-subscription.png)
+
+- 在个人设置中打开高级设置。
+- 一部番剧只订阅一个字幕组，点击 Mikan Project 的番剧图片即可呼出二级菜单，选择一个字幕组订阅即可。
+- 如果字幕组有简体繁体不同的字幕，Mikan Project 大多时候提供了选择订阅的方式，选择一种字幕订阅。
+- 如果不提供简繁选择，那么可以在 AutoBangumi 中设置 `filter` 进行过滤，也可以在规则生成之后进入 qBittorrent 中手动过滤。
+- 目前不支持 OVA 以及 剧场版 的订阅解析。
--- a/docs/deploy/Docker-compose.md
+++ b/docs/deploy/Docker-compose.md
@@ -1,101 +0,0 @@
-## 安装 **Docker Compose**
-
-现在提供了一键部署的 **AutoBangumi** 的方法，可以使用 `docker-compose.yml` 文件进行部署。
-
-正常来说安装完 Docker 之后都会自带 `docker-compose`，使用命令：
-
-```bash
-docker compose -v
-```
-
-检查版本即可
-
-如果没有安装，可以使用以下命令安装：
-
-```bash
- $ sudo apt-get update
- $ sudo apt-get install docker-compose-plugin
-```
-
-## 部署 **AutoBangumi**
-
-### 创建 AutoBangumi 文件夹
-
-```bash
-mkdir AutoBangumi
-cd AutoBangumi
-```
-
-### 下载 Docker Compose 配置文件
-
-项目中提供了三种安装方式：
-
- 只安装 **AutoBangumi**
-  ```bash
-  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/AutoBangumi/docker-compose.yml
-  ```
- 安装 **qBittorrent** 与 **AutoBangumi**
-  ```bash
-  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
-  ```
- **qBittorrent** + **AutoBangumi** + **Plex**
-  ```bash
-  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/All-in-one/docker-compose.yml
-  ```
-
-首先选择你要安装的方式，**拷贝上面的命令运行即可**，这一步是下载 `docker-compose.yml` 配置文件，如果需要自定义可以使用文本编辑器对其中的参数进行自定义。
-
-### 定义环境变量
-
-如果你是用上面下载的 AB+QB / AB+QB+Plex 的 Docker-Compose 文件，那么你需要定义以下环境变量：
-
-```shell
-export \
-QB_PORT=<YOUR_PORT>
-```
-
- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号，或者想要自定义的端口号，比如: `8080`
- `DOWNLOAD_PATH`: 填写你的文件下载路径
-
-如果你不想使用环境变量，也可以拉起 Docker-Compose 后在 WebUI 中进行配置。
-
-### 拉起 Docker-Compose
-
-```bash
-# 如果配置过了上面的环境变量，请使用下面的方式拉起
-docker compose up -d
-
-# 如果没有手动配置上面的环境变量，请使用下面的方式拉起
-QB_PORT=<QB_PORT> DOWNLOAD_PATH=<YOUR_DOWNLOAD_PATH> docker compose up -d
-```
-
-## 部署结果：
-
-```other
-2022-06-05 16:38:49 INFO: Add RSS Feed successfully.
-2022-06-05 16:38:50 INFO: Adding Kawaii dake ja Nai Shikimori-san Season 1
-2022-06-05 16:38:50 INFO: Adding Kakkou no Iinazuke Season 1
-2022-06-05 16:38:50 INFO: Adding SPYxFAMILY Season 1
-2022-06-05 16:38:50 INFO: Adding Love Live！虹咲学园 学园偶像同好会 Season 2
-2022-06-05 16:38:50 INFO: Adding CUE! Season 1
-2022-06-05 16:38:50 INFO: Adding Kaguya-sama wa Kokurasetai Season 3
-2022-06-05 16:38:50 INFO: Adding Shokei Shoujo no Virgin Road Season 1
-2022-06-05 16:38:50 INFO: Adding Kakkou no Iikagen Season 1
-2022-06-05 16:38:50 INFO: Adding Summer Time Rendering Season 1
-2022-06-05 16:38:50 INFO: Adding Mahoutsukai Reimeiki Season 1
-2022-06-05 16:38:50 INFO: Adding Paripi Koumei Season 1
-2022-06-05 16:38:50 INFO: Adding Komi-san wa, Komyushou Desu. Season 1
-2022-06-05 16:38:50 INFO: Adding Deaimon Season 1
-2022-06-05 16:38:50 INFO: Adding Tate no Yuusha no Nariagari Season 2
-2022-06-05 16:38:50 INFO: Adding Shijou Saikyou no Daimaou Season 1
-2022-06-05 16:38:50 INFO: Adding Yuusha, Yamemasu Season 1
-2022-06-05 16:38:50 INFO: Adding Tomodachi Game Season 1
-2022-06-05 16:38:50 INFO: Adding Machikado Mazoku: 2-choume Season 1
-2022-06-05 16:38:50 INFO: Start collecting past episodes.
-2022-06-05 16:39:32 INFO: Start adding rules.
-2022-06-05 16:39:32 INFO: Finished.
-2022-06-05 16:39:32 INFO: Waiting for downloading torrents...
-2022-06-05 16:49:32 INFO: Finished checking 185 file's name.
-2022-06-05 16:49:32 INFO: Renamed 0 files.
-2022-06-05 16:49:32 INFO: Finished rename process.
-```
--- a/docs/deploy/docker-cli.md
+++ b/docs/deploy/docker-cli.md
--- a/docs/deploy/docker-compose.md
+++ b/docs/deploy/docker-compose.md
@@ -0,0 +1,95 @@
+# 通过 Docker Compose 部署 AutoBangumi
+
+现在提供了一键部署的 **AutoBangumi** 的方法，可以使用 `docker-compose.yml` 文件进行部署。
+
+## 安装 Docker Compose
+
+正常来说安装完 Docker 之后都会自带 `docker-compose`，使用命令：
+
+```bash
+docker compose -v
+```
+
+检查版本即可
+
+如果没有安装，可以使用以下命令安装：
+
+```bash
+ $ sudo apt-get update
+ $ sudo apt-get install docker-compose-plugin
+```
+
+## 部署 **AutoBangumi**
+
+### 创建 AutoBangumi 文件夹
+
+```bash
+mkdir AutoBangumi
+cd AutoBangumi
+```
+
+### 选项1: 自定义 Docker Compose 配置文件
+
+```yaml
+version: "3.8"
+
+services:
+  AutoBangumi:
+    image: estrellaxd/auto_bangumi:latest
+    container_name: AutoBangumi
+    volumes:
+      - ./config:/app/config
+      - ./data:/app/data
+    ports:
+      - "7892:7892"
+    restart: unless-stopped
+    dns:
+      - 223.5.5.5
+
+volumes:
+  AutoBangumi_config:
+    name: AutoBangumi_config
+  AutoBangumi_data:
+    name: AutoBangumi_data
+```
+
+复制上面的内容到 `docker-compose.yml` 文件中。
+
+### 选项2: 下载 Docker Compose 配置文件
+
+当你不想自己创建 `docker-compose.yml` 文件时，
+项目中提供了三种安装方式：
+
+- 只安装 **AutoBangumi**
+  ```bash
+  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/AutoBangumi/docker-compose.yml
+  ```
+- 安装 **qBittorrent** 与 **AutoBangumi**
+  ```bash
+  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/qBittorrent+AutoBangumi/docker-compose.yml
+  ```
+- **qBittorrent** + **AutoBangumi** + **Plex**
+  ```bash
+  wget https://raw.githubusercontent.com/EstrellaXD/Auto_Bangumi/main/docs/docker-compose/All-in-one/docker-compose.yml
+  ```
+
+首先选择你要安装的方式，**拷贝上面的命令运行即可**，这一步是下载 `docker-compose.yml` 配置文件，如果需要自定义可以使用文本编辑器对其中的参数进行自定义。
+
+### 定义环境变量
+
+如果你是用上面下载的 AB+QB / AB+QB+Plex 的 Docker-Compose 文件，那么你需要定义以下环境变量：
+
+```shell
+export \
+QB_PORT=<YOUR_PORT>
+```
+
+- `QB_PORT`: 填写你的已经部署的 qBittorrent 端口号，或者想要自定义的端口号，比如: `8080`
+
+### 拉起 Docker-Compose
+
+```bash
+# 如果配置过了上面的环境变量，请使用下面的方式拉起
+docker compose up -d
+```
+
--- a/docs/deploy/dsm.md
+++ b/docs/deploy/dsm.md
@@ -0,0 +1,44 @@
+# 群晖 (DSM 7.2) 部署说明（ QNAP 同理）
+
+在 DSM 7.2 中，已经支持了 Docker Compose，推荐使用 Docker Compose 一键部署本项目。
+
+## 创建配置和数据存储文件夹
+
+
+## 安装 Container Manager (Docker) 套件
+
+进入套件中心，安装 Container Manager (Docker) 套件。
+
+![install-docker](../image/dsm/install-docker.png)
+
+## 通过 Docker compose 安装配置 AB
+
+点击 **项目**，然后点击 **新建**，选择 **Docker Compose**。
+
+![new-compose](../image/dsm/new-compose.png)
+
+复制以下内容填入 **Docker Compose** 中。
+```yaml
+version: "3.8"
+
+services:
+  ab:
+    image: "ghcr.io/estrellaxd/auto_bangumi:latest"
+    container_name: "auto_bangumi"
+    restart: unless-stopped
+    ports:
+      - "7892:7892"
+    volumes:
+      - "/volume1/docker/ab/config:/app/config"
+      - "/volume1/docker/ab/data:/app/data"
+      - "/volume1/docker/ab/log:/app/log"
+```
+
+点击 **下一步**，然后点击 **完成**。
+
+![create](../image/dsm/create.png)
+
+完成创建之后进入 `http://<NAS IP>:7892` 即可进入 AB 并进行配置。
+
+
+
--- a/docs/deploy/quick-start.md
+++ b/docs/deploy/quick-start.md
@@ -1,7 +1,7 @@
 ## 快速开始

 我们推荐你在 Docker 中部署运行 AutoBangumi。
-部署前请确认已经安装了 Docker Engine。
+部署前请确认已经安装了 [Docker Engine][docker-engine] 或者 [Docker Desktop][docker-desktop]。

 ### 创建数据和配置文件夹

@@ -61,3 +61,6 @@ volumes:

 此时 AB 的 WebUI 会自动运行，但是主程序会处于暂停状态，可以进入 `http://abhost:7892` 进行配置。

+
+[docker-engine]: https://docs.docker.com/engine/install/
+[docker-desktop]: https://www.docker.com/products/docker-desktop
--- a/docs/deploy/local-run.md
+++ b/docs/deploy/local-run.md
--- a/docs/deploy/Windows-本地部署.md
+++ b/docs/deploy/Windows-本地部署.md
@@ -1,3 +1,6 @@
+# Windows 本地部署
+
+
 1. 克隆并进入 AutoBangumi 的 `git` 仓库：

   ```powershell
--- a/docs/deploy/wsl.md
+++ b/docs/deploy/wsl.md
@@ -17,9 +17,9 @@ services:
      - GID=1000
      - QB_WEBUI_PORT=8989
    ports:
-      - 6881:6881
-      - 6881:6881/udp
-      - 8989:8989
+      - "6881:6881"
+      - "6881:6881/udp"
+      - "8989:8989"
    volumes:
      - qb_config:/config
      - /mnt/g/animation:/Downloads   #下载路径，对应 Windows上目录是 G:\animation
@@ -42,8 +42,8 @@ services:
      - PGID=1000
      - TZ=Asia/Shanghai
      - AB_DOWNLOADER_HOST=qbittorrent:8989
-      - AB_DOWNLOADER_USERNAME=admin 
-      - AB_DOWNLOADER_PASSWORD=adminadmin 
+      - AB_DOWNLOADER_USERNAME=admin
+      - AB_DOWNLOADER_PASSWORD=adminadmin
      - AB_NOT_CONTAIN=720|繁体|CHT|JPTC|繁日|BIG5
      - AB_DOWNLOAD_PATH=/Downloads  #qbittorrent 映射的地址，否者可能提示下载失败
      - AB_RSS=https://mikanani.me/RSS/MyBangumi?token=xxxxxxxx%3d%3d  #订阅地址，改成自己的
@@ -58,5 +58,4 @@ volumes:
    external: false
  auto_bangumi:
    external: false
-
 ```
--- a/docs/deploy/群晖.md
+++ b/docs/deploy/群晖.md
@@ -1,26 +0,0 @@
-## 群晖部署说明（ QNAP 同理）
-
-1. 安装 Docker 套件
-
-![docker.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8accwj20zc0u0wh4.jpg) 2. 在 Docker 中搜索 AutoBangumi 并且拉取
-
-![ab.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8zrv1j20zc0u0dka.jpg) 3. 配置 AutoBangumi
-
-![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8ludwj20wt0u0tam.jpg)
-
-![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd8fxvyj20zj0u078i.jpg)
-
-![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7u8x6j20wm0u0mzy.jpg)
-
-4. 如果你还没有安装 qBittorrent
-   配置如下：
-
-![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7ohctj20zh0u0mzq.jpg)
-
-![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd7h8bsj20wp0u040n.jpg)
-
-![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd6cgovj20wt0u00uj.jpg)
-
-## 运行结果
-
-![conf1.png](https://tva1.sinaimg.cn/large/e6c9d24ely1h47zd65jcbj21bx0u07bf.jpg)
--- a/docs/deploy/部署说明.md
+++ b/docs/deploy/部署说明.md
@@ -1,50 +0,0 @@
-# 开始前的准备
-
-**AutoBangumi** 可以使用 Docker 运行，也可以直接从源代码运行，鉴于追番是一个 7x24 小时的过程，**推荐**在 NAS 或者 Linux 服务器中使用 Docker 运行。
-
-## 获取 Mikan Project RSS 订阅地址
-
-本项目基于解析 Mikan Project 提供的 RSS 地址，因此如果要实现自动追番，需要注册并且获得 Mikan Project 的 RSS 地址：
-
-![image](https://raw.githubusercontent.com/EstrellaXD/ab_resource/main/resource/image/订阅地址.png)
-
-获取的 RSS 地址如下：
-
-```angular2html
-https://mikanani.me/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-# 或者
-https://mikanime.tv/RSS/MyBangumi?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-```
-
-AB 中需要填入的 `token` 为以上 url 中 `token=` 后面的一串字符。
-
-## Mikan Project 订阅贴士
-
-由于 AutoBangumi 会解析所有获得的 RSS 信息，因此在订阅番剧的时候需要注意以下几点：
-
-![image](https://raw.githubusercontent.com/EstrellaXD/ab_resource/main/resource/image/高级订阅.png)
-
- 在个人设置中打开高级设置。
- 一部番剧只订阅一个字幕组，点击 Mikan Project 的番剧图片即可呼出二级菜单，选择一个字幕组订阅即可。
- 如果字幕组有简体繁体不同的字幕，Mikan Project 大多时候提供了选择订阅的方式，选择一种字幕订阅。
- 如果不提供简繁选择，那么可以在 AutoBangumi 中设置 `filter` 进行过滤，也可以在规则生成之后进入 qBittorrent 中手动过滤。
- 目前不支持 OVA 以及 剧场版 的订阅解析。
-
-## 安装 Docker 以及 Docker Compose
-
- [安装 Docker 英文](https://docs.docker.com/get-docker/)
- [安装 Docker-Compose 英文](https://docs.docker.com/compose/)
- [安装 Docker 中文](https://sspai.com/post/56893)
- [Docker Compose 教程](https://sspai.com/post/66013)
-
-**推荐使用 Docker Compose 一键部署本项目**
-
-## 安装 qBittorrent 和媒体库
-
-如果你选择使用 Docker Compose 的方式安装，可以跳过这一步。
-如果你已经配置好已有的 qBittorrent 也可以跳过这一步。
-
-### 使用 Docker 安装 qBittorrent
-
- [安装说明](https://github.com/linuxserver/docker-qbittorrent)
- [群晖安装 qBittorrent](https://post.smzdm.com/p/a5k64587/)
--- a/docs/faq/排错流程.md
+++ b/docs/faq/排错流程.md
@@ -1,7 +1,7 @@
 ## ❌ 常用问题排错流程
 1. 如果 AB 无法正常启动，请检查启动命令是否正确, 当前版本正确的启动命令为 `/init`, 如果发现启动命令不正确且不会修改，请尝试重新部署 AB。
 2. 部署完 AB 之后请先查看 Log。如果运行如下说明 AB 运行正常，且与 QB 连接良好：
-      ```log
+      ```
      [2022-07-09 21:55:19,164] INFO:	                _        ____                                    _ 
      [2022-07-09 21:55:19,165] INFO:	     /\        | |      |  _ \                                  (_)
      [2022-07-09 21:55:19,166] INFO:	    /  \  _   _| |_ ___ | |_) | __ _ _ __   __ _ _   _ _ __ ___  _ 
@@ -20,11 +20,11 @@
      [2022-07-09 22:01:24,534] INFO:	[NC-Raws] 继母的拖油瓶是我的前女友 - 01 (B-Global 1920x1080 HEVC AAC MKV) [0B604F3A].mkv >> 继母的拖油瓶是我的前女友 S01E01.mkv
      ```
   1. 如果出现如下 LOG，说明 AB 无法连接 qBittorrent，请检查 qBittorrent 是否正常运行，如果 qBittorrent 正常运行，转跳 [网络问题](/faq/常见问题#🌍-网络链接) 部分进行排查。
-        ```log
+        ```
        [2022-07-09 22:01:24,534] WARNING:  Cannot connect to qBittorrent, wait 5min and retry
        ```
   2. 如果出现如下 LOG，说明 AB 无法连接到 Mikan RSS，请转跳到 [网络问题](/faq/常见问题#🌍-网络链接) 部分进行排查。
-        ```log
+        ```
        [2022-07-09 21:55:21,761] INFO:	    Start collecting RSS info.
        [2022-07-09 22:01:24,534] WARNING:  Connected Failed，please check DNS/Connection
        ```
--- a/docs/image/config/downloader.png
+++ b/docs/image/config/downloader.png
--- a/docs/image/config/manager.png
+++ b/docs/image/config/manager.png
--- a/docs/image/config/notifier.png
+++ b/docs/image/config/notifier.png
--- a/docs/image/config/parser.png
+++ b/docs/image/config/parser.png
--- a/docs/image/config/program.png
+++ b/docs/image/config/program.png
--- a/docs/image/config/proxy.png
+++ b/docs/image/config/proxy.png
--- a/docs/image/dsm/create.png
+++ b/docs/image/dsm/create.png
--- a/docs/image/dsm/install-docker.png
+++ b/docs/image/dsm/install-docker.png
--- a/docs/image/dsm/new-compose.png
+++ b/docs/image/dsm/new-compose.png
--- a/docs/image/rss/advanced-subscription.png
+++ b/docs/image/rss/advanced-subscription.png
--- a/docs/image/rss/rss-token.png
+++ b/docs/image/rss/rss-token.png
--- a/docs/index.md
+++ b/docs/index.md
@@ -8,15 +8,17 @@ hero:
  actions:
    - theme: brand
      text: 快速开始
-      link: /home/
+      link: /deploy/quick-start
    - theme: alt
      text: 更新日志
      link: /changelog/3.0

 features:
-  - title: 自动解析番剧名称
+  - icon: 🤖️
+    title: 自动解析番剧名称
    details: 从 Mikan Project 自动解析番剧名称，无需手动输入，仅需订阅即可自动创建下载规则。
-  - title: 自动番剧重命名
+  - icon: 📁
+    title: 自动番剧重命名
    details: 自动管理下载的番剧，保证刮削成功率，保证目录结构统一。
  - title: 手动式一键管理
    details: 一键管理已有番剧，一键下载旧番，一键删除番剧。