Skip to content

Commit 9db172a

Browse files
VirgilClyneVirgilClyne
committed
docs: rewrite
Update universal.mdx Update youtube.mdx Update spotify.mdx Update addon.mdx Update netflix.mdx Update box-js.mdx Update index.md
1 parent ea9b03a commit 9db172a

7 files changed

Lines changed: 176 additions & 113 deletions

File tree

‎docs/guide/addon.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ import _Footer from "./_Footer.md";
1010
* Akamaized
1111
* 提供 Akamaized.net 流媒体解决方案的字幕翻译
1212

13+
## 使用说明
14+
* Microsoft Translate
15+
* 安装后，等待每10分钟自动运行，首次使用需等待10分钟第一次刷新
16+
* Akamaized
17+
* 详见[🍿 DualSubs: 🔣 Universal#使用说明](./universal#使用说明)
18+
1319
## 功能列表
1420
* Microsoft Translate
1521
* 每十分钟自动更新并填写Token
1622
* 将翻译器自动切换为Microsoft Translate
1723
* Akamaized
1824
* 对于 `https://*.akamaized.net/out/v1/${hash}.m3u8` 的直播流地址进行字幕翻译
1925

20-
## 使用说明
21-
* Microsoft Translate
22-
* 安装后，等待每10分钟自动运行，首次使用需等待10分钟第一次刷新
23-
* Akamaized
24-
* 详见[🍿 DualSubs: 🔣 Universal#使用说明](./universal#使用说明)
25-
2626
## 安装链接
2727
### Microsoft Translate
2828
<ModuleInstall urlPrefix="https://github.com/DualSubs/AddOn/releases/latest/download/">

‎docs/guide/box-js.mdx‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,20 @@ import { ModuleInstall } from "@theme";
22
import _Footer from "./_Footer.md";
33

44
# 🧰 BoxJs
5-
:::info ❕
65

7-
BoxJs仅用于可视化配置
6+
:::info ℹ️ 用前须知
7+
`BoxJs`仅用于可视化配置
88
请搭配模块/插件/覆写等使用
99

1010
:::
1111

12+
:::info ℹ️ 用前须知
13+
14+
使用`BoxJs`进行配置将被视为专业用户
15+
官方不受理因使用`BoxJs`配置导致的各种问题
16+
17+
:::
18+
1219
## 使用说明
1320
* [BoxJs官方说明文档](https://chavyleung.gitbook.io/boxjs/)
1421

‎docs/guide/netflix.mdx‎

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,48 @@ import _Footer from "./_Footer.md";
33

44
# 🇳 Netflix
55

6+
:::info ℹ️ 用前须知
7+
8+
* 由于 Netflix 已为关键域名固定证书（禁止MitM），本脚本仅能于`兼容模式`下提供双语翻译字幕
9+
* 兼容模式: 指无法检测字幕语言，无法在 Netflix 中生成双语字幕选项，仅`翻译字幕`模式可用
10+
11+
:::
12+
613
## 简介
714
详见[🍿 DualSubs: 🔣 Universal#简介](./universal#简介)
815

16+
## 使用说明
17+
* 基础: 直接使用（采用默认配置）
18+
* 默认主语言`自动检测`，副语言`简体中文`
19+
* 总是将当前所选字幕替换为双语字幕
20+
* `翻译器`默认使用`Google翻译`进行字幕翻译，将字幕按127句为单位划分，进行整段翻译。
21+
* 进阶: 配合`Loon`设置面板或`Surge`参数设置功能进行个性化设置
22+
* 提供一定的自定义设置，如`主语言`、`副语言`、`翻译器`选择等
23+
* 高级: 配合`BoxJs`及订阅使用
24+
<details>
25+
<summary>ℹ️ 用前须知：使用`BoxJs`进行配置将被视为专业用户，官方不受理因使用`BoxJs`配置导致的各种问题</summary>
26+
27+
1. 安装`BoxJs`插件并更新引用资源或脚本:
28+
* 安装方法及下载链接详见: [🧰 BoxJs](./box-js)
29+
2. 在`BoxJs`的配置面板中进行个性化设置:
30+
1. 浏览器访问[BoxJs.com](http://boxjs.com)
31+
2. 在[`应用`](http://boxjs.com/#/app)页面点开`DualSubs`折叠
32+
3. 根据需要配置每个流媒体平台的设置
33+
4. (可选) 在`DualSubs: Verify`中配置第三方API验证信息
34+
5. (可选) 在`DualSubs: Advanced Options`中配置高级设置
35+
* `字幕类型`为多选框，多选保存后，对应APP中的`字幕`选项也会增加对应的字幕选项
36+
* `首选语言`为主语言，对应第一行字幕语言
37+
* `次选语言`为副语言，对应第二行字幕语言
38+
* 需在`字幕类型`中勾选`外部字幕`,`外部字幕文件URL`中填写的字幕文件才会生效（需要为绝对路径，支持WebVTT, SRT）
39+
* `外部字幕偏移量`为内置字幕时间轴矫正功能，时间单位为毫秒，正负整数，可以用来省略第三方字幕转换器
40+
* `播放记录缓存数量`提供设置数量的复数缓存空间，当你的设备同时为局域网内多个设备提供流媒体平台字幕增强功能时，保证字幕数据不会错乱，同时对于`Disney+`这种自带长期缓存的流媒体平台，提供更好的兼容性
41+
* `时间戳公差`为`官方字幕`或`外部字幕`匹配时，每句字幕匹配时的时间容差，因同平台同视频不同语言字幕往往交付不同翻译人员进行翻译，相同台词的时间戳可能有0.5秒-1.5秒乃至更多的误差，或者一句台词对应另外一种语言多句台词的情况，`时间戳公差`值会将此误差范围的台词视为同一句台词进行合并，且支持一句台词对多句台词合并
42+
</details>
43+
944
## 功能列表
1045
详见[🍿 DualSubs: 🔣 Universal#功能列表](./universal#功能列表)
1146

12-
## 使用说明
13-
详见[🍿 DualSubs: 🔣 Universal#使用说明](./universal#使用说明)
14-
1547
## 安装链接
16-
* 由于 Netflix 已为关键域名固定证书（禁止MitM），本脚本仅能于`兼容模式`下提供双语翻译字幕
17-
* 兼容模式: 指无法检测字幕语言，无法在Netflix app中生成双语字幕选项，仅`翻译字幕`模式可用
18-
* 只能通过BoxJs面板进行功能和语言控制，由本项目 [🧰 BoxJs](./box-js) 面板提供
19-
2048
<ModuleInstall
2149
urlPrefix="https://github.com/DualSubs/Netflix/releases/latest/download/"
2250
urls={{

‎docs/guide/spotify.mdx‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,38 @@ import _Footer from "./_Footer.md";
55

66
## 简介
77
* 翻译歌词功能：详见[🍿 DualSubs: 🔣 Universal#简介](./universal#简介)
8-
* 外部歌词功能：自动为无歌词的歌曲补全歌词，来源为用户自选的第三方音乐API（默认为 `网易云音乐`）
8+
* 外部歌词功能：自动为无歌词的歌曲补全歌词，来源为用户自选的第三方音乐API
9+
10+
## 使用说明
11+
* 基础: 直接使用（采用默认配置）
12+
* 存在官方歌词时，使用`翻译器`将官方歌词翻译双语歌词
13+
* 点击歌词面板右上角的`翻译`按钮即可显示双语歌词
14+
* 不存在官方歌词时，自动为歌曲补全`外部源`歌词
15+
* 无需任何操作，自动为歌曲补全歌词
16+
* 默认`外部源`为`网易云音乐`
17+
* 当`外部源`提供歌词原文及翻译时，歌词面板右下角显示`翻译`按钮
18+
* 对于 Spotify App: 拥有歌词的歌曲，点击歌词面板右上角的`翻译`按钮即可显示双语歌词
19+
* 对于 Spotify Web: 拥有歌词的歌曲，歌词直接显示为两行双语
20+
* 进阶: 配合`Loon`设置面板或`Surge`参数设置功能进行个性化设置
21+
* 提供一定的自定义设置，如`翻译器`选择、`外部源`选择等
22+
* 高级: 配合`BoxJs`及订阅使用
23+
<details>
24+
<summary>ℹ️ 用前须知：使用`BoxJs`进行配置将被视为专业用户，官方不受理因使用`BoxJs`配置导致的各种问题</summary>
25+
26+
1. 安装`BoxJs`插件并更新引用资源或脚本:
27+
* 安装方法及下载链接详见: [🧰 BoxJs](./box-js)
28+
2. 在`BoxJs`的配置面板中进行个性化设置:
29+
1. 浏览器访问[BoxJs.com](http://boxjs.com)
30+
2. 在[`应用`](http://boxjs.com/#/app)页面点开`DualSubs`折叠
31+
3. 根据需要访问对应的配置面板配置高级设置
32+
</details>
933

1034
## 功能列表
1135
* 翻译歌词功能：详见[🍿 DualSubs: 🔣 Universal#功能列表](./universal#功能列表)
1236
* 外部歌词功能：在第三方平台上检索对应的歌曲歌词，转换为Spotify格式并输出
1337
* 网易云音乐（官方，支持逐字歌词）
1438
* 网易云音乐 Node.js API（支持逐字歌词）
15-
* QQ 音乐（官方）
16-
17-
## 使用说明
18-
* 开箱即用
19-
* App: 拥有歌词的歌曲，点击歌词面板右上角的`翻译`按钮即可显示双语歌词
20-
* Web: 拥有歌词的歌曲，歌词直接显示为双语
39+
* QQ 音乐（官方，不支持逐字歌词）
2140

2241
## 安装链接
2342
### 歌词双语翻译与补全

‎docs/guide/universal.mdx‎

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,37 @@ import _Footer from "./_Footer.md";
55

66
## 简介
77
* 安装后无需任何额外配置，即可为支持的平台添加双语字幕及对应的字幕选项
8-
* 默认字幕语言首选`中文（自动）`，次选`英文（自动）`
9-
* 默认采用Google翻译，将字幕按127句为单位划分，进行整段翻译。
8+
* 用户需要在播放器的字幕选项中选择脚本新增的`双语字幕`或`翻译字幕`选项，即可在播放器中显示双语字幕
9+
10+
## 使用说明
11+
* 基础: 直接使用（采用默认配置）
12+
* 默认主语言`英文（自动）`，副语言`中文（自动）`
13+
* 兼容的平台：增加`官方双语`与`翻译双语`字幕选项
14+
* 如平台未提供副语言字幕，则仅增加`翻译双语`字幕选项
15+
* 不兼容[^4]的平台：将主语言字幕替换替换为双语字幕
16+
* `翻译器`默认使用`Google翻译`进行字幕翻译，将字幕按127句为单位划分，进行整段翻译。
17+
* 进阶: 配合`Loon`设置面板或`Surge`参数设置功能进行个性化设置
18+
* 提供一定的自定义设置，如`主语言`、`副语言`、`翻译器`选择等
19+
* 高级: 配合`BoxJs`及订阅使用
20+
<details>
21+
<summary>ℹ️ 用前须知：使用`BoxJs`进行配置将被视为专业用户，官方不受理因使用`BoxJs`配置导致的各种问题</summary>
22+
23+
1. 安装`BoxJs`插件并更新引用资源或脚本:
24+
* 安装方法及下载链接详见: [🧰 BoxJs](./box-js)
25+
2. 在`BoxJs`的配置面板中进行个性化设置:
26+
1. 浏览器访问[BoxJs.com](http://boxjs.com)
27+
2. 在[`应用`](http://boxjs.com/#/app)页面点开`DualSubs`折叠
28+
3. 根据需要配置每个流媒体平台的设置
29+
4. (可选) 在`DualSubs: Verify`中配置第三方API验证信息
30+
5. (可选) 在`DualSubs: Advanced Options`中配置高级设置
31+
* `字幕类型`为多选框，多选保存后，对应APP中的`字幕`选项也会增加对应的字幕选项
32+
* `首选语言`为主语言，对应第一行字幕语言
33+
* `次选语言`为副语言，对应第二行字幕语言
34+
* 需在`字幕类型`中勾选`外部字幕`,`外部字幕文件URL`中填写的字幕文件才会生效（需要为绝对路径，支持WebVTT, SRT）
35+
* `外部字幕偏移量`为内置字幕时间轴矫正功能，时间单位为毫秒，正负整数，可以用来省略第三方字幕转换器
36+
* `播放记录缓存数量`提供设置数量的复数缓存空间，当你的设备同时为局域网内多个设备提供流媒体平台字幕增强功能时，保证字幕数据不会错乱，同时对于`Disney+`这种自带长期缓存的流媒体平台，提供更好的兼容性
37+
* `时间戳公差`为`官方字幕`或`外部字幕`匹配时，每句字幕匹配时的时间容差，因同平台同视频不同语言字幕往往交付不同翻译人员进行翻译，相同台词的时间戳可能有0.5秒-1.5秒乃至更多的误差，或者一句台词对应另外一种语言多句台词的情况，`时间戳公差`值会将此误差范围的台词视为同一句台词进行合并，且支持一句台词对多句台词合并
38+
</details>
1039

1140
## 功能列表
1241
1. 官方播放器内提供自定义字幕选项
@@ -36,30 +65,6 @@ import _Footer from "./_Footer.md";
3665
9. 翻译字幕模式支持`逐段翻译`（默认）和`逐行翻译`
3766
* `逐段翻译`对于大分段的字幕文件的平台（如：HBO Max）响应更快，翻译效果更好，利于限制使用频率的翻译API。
3867

39-
## 使用说明
40-
* 基础: 直接使用
41-
* 采用默认配置
42-
* 默认主语言`中文（自动）`，副语言`英文（自动）`
43-
* 提供官方中文的平台的语言选项为`官方字幕`和`Google翻译`
44-
* 未提供中文的平台的语言选项为`Google翻译`
45-
* 不兼容[^4]平台的替换语言选项为`Google翻译`
46-
* 高级: 配合`BoxJs`及订阅使用
47-
1. 安装`BoxJs`插件并更新引用资源或脚本:
48-
* 安装方法及下载链接详见: [🧰 BoxJs](./box-js)
49-
2. 在`BoxJs`的配置面板中进行个性化设置:
50-
1. 浏览器访问[BoxJs.com](http://boxjs.com)
51-
2. 在[`应用`](http://boxjs.com/#/app)页面点开`DualSubs`折叠
52-
3. 根据需要配置每个流媒体平台的设置
53-
1. `字幕类型`为多选框，多选保存后，对应APP中的`字幕`选项也会增加对应的字幕选项
54-
2. `首选语言`为主语言，对应第一行字幕语言
55-
3. `次选语言`为副语言，对应第二行字幕语言
56-
4. 需在`字幕类型`中勾选`外部字幕`,`外部字幕文件URL`中填写的字幕文件才会生效（需要为绝对路径，支持WebVTT, SRT）
57-
5. `外部字幕偏移量`为内置字幕时间轴矫正功能，时间单位为毫秒，正负整数，可以用来省略第三方字幕转换器
58-
6. `播放记录缓存数量`提供设置数量的复数缓存空间，当你的设备同时为局域网内多个设备提供流媒体平台字幕增强功能时，保证字幕数据不会错乱，同时对于`Disney+`这种自带长期缓存的流媒体平台，提供更好的兼容性
59-
7. `时间戳公差`为`官方字幕`或`外部字幕`匹配时，每句字幕匹配时的时间容差，因同平台同视频不同语言字幕往往交付不同翻译人员进行翻译，相同台词的时间戳可能有0.5秒-1.5秒乃至更多的误差，或者一句台词对应另外一种语言多句台词的情况，`时间戳公差`值会将此误差范围的台词视为同一句台词进行合并，且支持一句台词对多句台词合并
60-
4. (可选)在`DualSubs: Verify`中配置第三方API验证信息
61-
5. (可选)在`DualSubs: Advanced Options`中配置高级设置
62-
6368
## 安装链接
6469
* 因v0.8版结构升级，旧版用户请清空[`DualSubs在BoxJs的全部设置`](./wiki/在BoxJs中清除DualSubs的储存数据#清除全部储存数据)后重新设置
6570
* 因iOS16.4起`MitM`政策变更，TV及Fitness平台，需要配合[` iRingo: 📺 TV`](https://nsringo.github.io/guide/apple-tv)恢复支持

‎docs/guide/youtube.mdx‎

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,38 @@ import { ModuleInstall } from "@theme";
22
import _Footer from "./_Footer.md";
33

44
# ▶️ YouTube (Music)
5-
:::info ❕
5+
:::info ℹ️ 用前须知
66

7-
`tvOS`上的`YouTube app`所使用的`www.DualSubs.YouTube.com`不可以 MitM
7+
`tvOS`上的`YouTube app`所使用的`www.youtube.com`不可以 MitM
88
故本作品不适用于`tvOS`上的`YouTube app`
99

1010
:::
1111

1212
## 简介
1313
安装后无需任何配置，即可为移动端启用双语字幕，Web端解锁全部翻译语言选项，选择任一翻译语言，即为原始语言与翻译语言双语字幕
1414

15+
## 使用说明
16+
* 基础: 直接使用（采用默认配置）
17+
* 在播放器`字幕`-`自动翻译`中任选一种语言，即为此语言与原语言双语字幕
18+
* 支持默认开启双语字幕
19+
* 第二语言为上次用户所使用的翻译语言
20+
* 可通过BoxJs面板关闭此功能或强制指定为某种语言
21+
* 支持任意两种语言字幕合成
22+
* 第一语言为上次用户所使用的原语言
23+
* 进阶: 配合`Loon`设置面板或`Surge`参数设置功能进行个性化设置
24+
* 提供一定的自定义设置，如`翻译器`选择、`外部源`选择等
25+
* 高级: 配合`BoxJs`及订阅使用
26+
<details>
27+
<summary>ℹ️ 用前须知：使用`BoxJs`进行配置将被视为专业用户，官方不受理因使用`BoxJs`配置导致的各种问题</summary>
28+
29+
1. 安装`BoxJs`插件并更新引用资源或脚本:
30+
* 安装方法及下载链接详见: [🧰 BoxJs](./box-js)
31+
2. 在`BoxJs`的配置面板中进行个性化设置:
32+
1. 浏览器访问[BoxJs.com](http://boxjs.com)
33+
2. 在[`应用`](http://boxjs.com/#/app)页面点开`DualSubs`折叠
34+
3. 根据需要访问对应的配置面板配置高级设置
35+
</details>
36+
1537
## 功能列表
1638
1. 支持`Web端`和`移动端`的`播放器`全翻译语言选项解锁
1739
2. 支持`Web端`和`移动端`有字幕视频的`自动翻译`及`自动生成`双语
@@ -24,24 +46,6 @@ import _Footer from "./_Footer.md";
2446
* 第一语言为上次用户所使用的原语言
2547
5. `自动翻译`语言选项列表现在为双语列表
2648

27-
## 使用说明
28-
* 基础: 直接使用
29-
* 采用默认配置
30-
* 在播放器`字幕`-`自动翻译`中任选一种语言，即为此语言与原语言双语字幕
31-
* 支持默认开启双语字幕
32-
* 第二语言为上次用户所使用的翻译语言
33-
* 可通过BoxJs面板关闭此功能或强制指定为某种语言
34-
* 支持任意两种语言字幕合成
35-
* 第一语言为上次用户所使用的原语言
36-
* 高级: 配合`BoxJs`及订阅使用
37-
1. 安装`BoxJs`插件并更新引用资源或脚本:
38-
* 安装方法及下载链接详见: [🧰 BoxJs](./box-js)
39-
2. 在`BoxJs`的配置面板中进行个性化设置:
40-
1. 浏览器访问[BoxJs.com](http://boxjs.com)
41-
2. 在[`应用`](http://boxjs.com/#/app)页面点开`DualSubs`折叠
42-
3. 根据需要配置每个流媒体平台的设置
43-
4. 功能将会持续增加
44-
4549
## 安装链接
4650
* 字幕合成与翻译脚本，现在与 Universal 版共用
4751
* 不再提供`配合去广告版`，将`YouTube去广告模块`优先级高于本字幕插件（Surge为置于本插件下方，Loon为置于本插件上方）即可

‎docs/index.md‎

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,56 @@
22
pageType: home
33

44
hero:
5-
icon: 🍿️
6-
name: 🍿️ DualSubs
7-
text: |
8-
双语及增强字幕生成工具
9-
tagline: 开箱即用，原生体验
10-
actions:
11-
- theme: brand
12-
text: 快速开始
13-
link: /guide/
14-
- theme: alt
15-
text: GitHub
16-
link: https://github.com/DualSubs
17-
image:
18-
src: https://avatars.githubusercontent.com/u/100578089?s=400&v=4
19-
alt: DualSubs Logo
5+
icon: 🍿️
6+
name: 🍿️ DualSubs
7+
text: |
8+
双语及增强字幕生成工具
9+
tagline: 开箱即用，原生体验
10+
actions:
11+
- theme: brand
12+
text: 快速开始
13+
link: /guide/
14+
- theme: alt
15+
text: 支持平台列表
16+
link: /guide/appendix/supported-platforms
17+
image:
18+
src: https://avatars.githubusercontent.com/u/100578089?s=400&v=4
19+
alt: DualSubs Logo
2020

2121
features:
22-
- icon: 🔣
23-
title: Universal
24-
details: 流媒体平台通用
25-
span: 4
26-
link: /guide/universal
22+
- icon: 🔣
23+
title: Universal
24+
details: HLS 流媒体平台通用
25+
span: 4
26+
link: /guide/universal
2727

28-
- icon: ▶️
29-
title: YouTube (Music)
30-
details: YouTube (Music) 专用
31-
span: 4
32-
link: /guide/youtube
28+
- icon: ▶️
29+
title: YouTube (Music)
30+
details: YouTube (Music) 专用
31+
span: 4
32+
link: /guide/youtube
3333

34-
- icon: 🎵
35-
title: Spotify
36-
details: Spotify 专用
37-
span: 4
38-
link: /guide/spotify
34+
- icon: 🎵
35+
title: Spotify
36+
details: Spotify 专用
37+
span: 4
38+
link: /guide/spotify
3939

40-
- icon: 🇳
41-
title: Netflix
42-
details: Netflix 专用
43-
span: 4
44-
link: /guide/netflix
40+
- icon: 🇳
41+
title: Netflix
42+
details: Netflix 专用
43+
span: 4
44+
link: /guide/netflix
4545

46-
- icon: ➕
47-
title: AddOn
48-
details: 其他插件
49-
span: 4
50-
link: /guide/addon
46+
- icon: ➕
47+
title: AddOn
48+
details: 其他插件
49+
span: 4
50+
link: /guide/addon
5151

52-
- icon: 🧰
53-
title: BoxJs
54-
details: 可视化配置面板
55-
span: 4
56-
link: /guide/box-js
52+
- icon: 🧰
53+
title: BoxJs
54+
details: 可视化配置面板
55+
span: 4
56+
link: /guide/box-js
5757
---

0 commit comments

Comments
 (0)