Skip to content

Commit

Permalink
Update all descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
the1812 committed Dec 5, 2021
1 parent 384f053 commit d842469
Show file tree
Hide file tree
Showing 52 changed files with 221 additions and 178 deletions.
77 changes: 39 additions & 38 deletions doc/features/features.json

Large diffs are not rendered by default.

94 changes: 49 additions & 45 deletions doc/features/features.md

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions doc/features/pack/pack.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
"name": "cleaner",
"displayName": "简洁至上",
"description": "简化各种多余界面元素, 专注于内容本身.",
"description": "简化各种多余界面元素, 专注于内容本身.\n包含以下功能:\n删除广告, 删除直播水印, 删除视频弹窗, 禁用特殊弹幕样式, 简化评论区, 简化直播间, 简化首页, 自动收起直播侧栏, 隐藏视频推荐, 隐藏直播推荐, 隐藏视频标题层, 自动隐藏侧栏",
"components": [
"removePromotions",
"removeLiveWatermark",
Expand All @@ -22,7 +22,7 @@
"type": "component",
"name": "removePromotions",
"displayName": "删除广告",
"description": "删除站内的各种广告. 包括首页的推广模块, 手机app推荐, 视频页面右侧的广告等.\n\n- `占位文本`: 删除首页推广模块的广告后显示\"🚫已屏蔽广告\"来替代空白区域.\n- `保留活动横幅`: 保留视频页面的活动横幅.",
"description": "删除站内的各种广告. 包括首页的推广模块, 手机 app 推荐, 视频页面右侧的广告等. 注意: 首页推广模块删除后留下空白区域是正常现象, 如果觉得怪可以开启 `占位文本` 选项.\n\n- `占位文本`: 删除首页推广模块的广告后显示\"🚫已屏蔽广告\"来替代空白区域.\n- `保留活动横幅`: 保留视频页面的活动横幅.",
"fullRelativePath": "../../registry/dist/components/utils/remove-promotions.js",
"fullAbsolutePath": "registry/dist/components/utils/remove-promotions.js"
},
Expand All @@ -46,15 +46,15 @@
"type": "component",
"name": "disableSpecialDanmaku",
"displayName": "禁用特殊弹幕样式",
"description": "移除高赞弹幕或UP主弹幕的特殊样式, 弹幕内容不会移除.",
"description": "移除高赞弹幕或 UP 主弹幕的特殊样式, 弹幕内容不会移除.",
"fullRelativePath": "../../registry/dist/components/style/special-danmaku.js",
"fullAbsolutePath": "registry/dist/components/style/special-danmaku.js"
},
{
"type": "component",
"name": "simplifyComments",
"displayName": "简化评论区",
"description": "- 删除热评头像下方的关注按钮\n- 删除用户的等级标识\n- 删除发送源信息(`来自安卓客户端`这种)\n- 删除用户名右边的勋章\n- 删除评论区顶部的横幅\n- 发送时间移动到右上角\n- 位图图标全部换用矢量图标, 高分屏不会模糊\n- 投票仅显示链接, 隐藏下面的大框.\n\n> 注: 关注和等级可以通过鼠标停留在头像上, 在弹出的资料卡小窗中查看.",
"description": "- 删除热评头像下方的关注按钮\n- 删除用户的等级标识\n- 删除发送源信息(`来自安卓客户端` 这种)\n- 删除用户名右边的勋章\n- 删除评论区顶部的横幅\n- 发送时间移动到右上角\n- 位图图标全部换用矢量图标, 高分屏不会模糊\n- 投票仅显示链接, 隐藏下面的大框.\n\n> 注: 关注和等级可以通过鼠标停留在头像上, 在弹出的资料卡小窗中查看.",
"fullRelativePath": "../../registry/dist/components/style/simplify/comments.js",
"fullAbsolutePath": "registry/dist/components/style/simplify/comments.js"
},
Expand All @@ -70,31 +70,31 @@
"type": "component",
"name": "simplifyHome",
"displayName": "简化首页",
"description": "隐藏原版首页不需要的元素/分区.",
"description": "隐藏原版首页不需要的元素 / 分区.\n\n> 这个功能相当于 v1 的 `首页过滤`, v1 的 `简化首页` (清爽 / 极简首页) 需要重构后再发布, 问就是 Coming Soon.",
"fullRelativePath": "../../registry/dist/components/style/simplify/home.js",
"fullAbsolutePath": "registry/dist/components/style/simplify/home.js"
},
{
"type": "component",
"name": "collapseLiveSideBar",
"displayName": "自动收起直播侧栏",
"description": "暂无描述.",
"description": "自动收起直播间右边偏下的侧栏. (上面有个 \"关注\" 的面板)",
"fullRelativePath": "../../registry/dist/components/live/side-bar.js",
"fullAbsolutePath": "registry/dist/components/live/side-bar.js"
},
{
"type": "component",
"name": "hideRelatedVideos",
"displayName": "隐藏视频推荐",
"description": "隐藏番剧和视频页面右侧的推荐视频列表. 注意: 如果你想关闭 b 站的自动连播(自动播放下一个推荐视频)功能, 需要先取消隐藏视频推荐才能看到开关.",
"description": "隐藏番剧和视频页面右侧的推荐视频列表. 注意: 如果你想关闭 b 站的自动连播 (自动播放下一个推荐视频) 功能, 需要先取消隐藏视频推荐才能看到开关.",
"fullRelativePath": "../../registry/dist/components/style/hide/video/related-videos.js",
"fullAbsolutePath": "registry/dist/components/style/hide/video/related-videos.js"
},
{
"type": "component",
"name": "hideRecommendedLive",
"displayName": "隐藏推荐直播",
"description": "隐藏视频页面右侧下方的推荐直播.",
"displayName": "隐藏直播推荐",
"description": "隐藏视频页面右侧下方的直播推荐.",
"fullRelativePath": "../../registry/dist/components/style/hide/video/recommended-live.js",
"fullAbsolutePath": "registry/dist/components/style/hide/video/recommended-live.js"
},
Expand All @@ -110,7 +110,7 @@
"type": "component",
"name": "autoHideSidebar",
"displayName": "自动隐藏侧栏",
"description": "自动隐藏脚本的侧栏(功能和设置图标). 设置面板停靠在右侧时不建议使用, 因为网页的滚动条会占用右边缘的触发区域.",
"description": "自动隐藏脚本的侧栏 (功能和设置图标). 设置面板停靠在右侧时不建议使用, 因为网页的滚动条会占用右边缘的触发区域.",
"fullRelativePath": "../../registry/dist/components/style/auto-hide-sidebar.js",
"fullAbsolutePath": "registry/dist/components/style/auto-hide-sidebar.js"
}
Expand All @@ -120,7 +120,7 @@
{
"name": "downloader",
"displayName": "下载器",
"description": "包含下载各种内容的功能.",
"description": "包含下载各种内容的功能.\n包含以下功能:\n下载视频, 下载字幕, 下载弹幕, 下载音频, 直播录像下载",
"components": [
"downloadVideo",
"downloadSubtitle",
Expand All @@ -133,7 +133,7 @@
"type": "component",
"name": "downloadVideo",
"displayName": "下载视频",
"description": "暂无描述.",
"description": "在功能面板中添加下载视频支持.",
"fullRelativePath": "../../registry/dist/components/video/download.js",
"fullAbsolutePath": "registry/dist/components/video/download.js"
},
Expand Down Expand Up @@ -175,7 +175,7 @@
{
"name": "starter",
"displayName": "常用功能包",
"description": "包含一些常用功能.",
"description": "包含一些常用功能.\n包含以下功能:\n使用细滚动条, 自定义顶栏, 删除广告, 专栏文字选择, 网址参数清理, 快捷键扩展, 查看封面, BV 号转换, 删除直播水印, 直播弹幕发送栏, 直播全屏包裹, 展开动态内容, 动态反折叠, 快速收起评论, 禁止跳转动态详情, 展开视频简介, 设置面板 - \"最近使用\" 类别",
"components": [
"elegantScrollbar",
"customNavbar",
Expand All @@ -202,7 +202,7 @@
"type": "component",
"name": "elegantScrollbar",
"displayName": "使用细滚动条",
"description": "暂无描述.",
"description": "使用浏览器的滚动条风格替代系统的滚动条, 不过 macOS 系统滚动条比浏览器做得好一些, 因此不建议 macOS 使用此功能.",
"fullRelativePath": "../../registry/dist/components/style/scrollbar.js",
"fullAbsolutePath": "registry/dist/components/style/scrollbar.js"
},
Expand All @@ -218,7 +218,7 @@
"type": "component",
"name": "removePromotions",
"displayName": "删除广告",
"description": "删除站内的各种广告. 包括首页的推广模块, 手机app推荐, 视频页面右侧的广告等.\n\n- `占位文本`: 删除首页推广模块的广告后显示\"🚫已屏蔽广告\"来替代空白区域.\n- `保留活动横幅`: 保留视频页面的活动横幅.",
"description": "删除站内的各种广告. 包括首页的推广模块, 手机 app 推荐, 视频页面右侧的广告等. 注意: 首页推广模块删除后留下空白区域是正常现象, 如果觉得怪可以开启 `占位文本` 选项.\n\n- `占位文本`: 删除首页推广模块的广告后显示\"🚫已屏蔽广告\"来替代空白区域.\n- `保留活动横幅`: 保留视频页面的活动横幅.",
"fullRelativePath": "../../registry/dist/components/utils/remove-promotions.js",
"fullAbsolutePath": "registry/dist/components/utils/remove-promotions.js"
},
Expand All @@ -242,7 +242,7 @@
"type": "component",
"name": "keymap",
"displayName": "快捷键扩展",
"description": "为视频播放器启用更多的快捷键, 快捷键列表可在`快捷键设置`中查看和配置.",
"description": "为脚本的功能和 b 站的功能启用键盘快捷键支持, 快捷键列表可在`快捷键设置`中查看和配置.",
"fullRelativePath": "../../registry/dist/components/utils/keymap.js",
"fullAbsolutePath": "registry/dist/components/utils/keymap.js"
},
Expand All @@ -257,8 +257,8 @@
{
"type": "component",
"name": "bvidConvert",
"displayName": "BV号转换",
"description": "在功能面板中显示视频的AV号和BV号.",
"displayName": "BV 号转换",
"description": "在功能面板中显示视频的 AV 号和 BV 号.",
"fullRelativePath": "../../registry/dist/components/video/bvid-convert.js",
"fullAbsolutePath": "registry/dist/components/video/bvid-convert.js"
},
Expand Down Expand Up @@ -329,7 +329,7 @@
{
"type": "plugin",
"name": "settingsPanel.tagFilters.recentComponents",
"displayName": "设置面板 - \"最近使用\"类别",
"displayName": "设置面板 - \"最近使用\" 类别",
"fullRelativePath": "../../registry/dist/plugins/settings-panel/recent-components.js",
"fullAbsolutePath": "registry/dist/plugins/settings-panel/recent-components.js"
}
Expand Down
6 changes: 6 additions & 0 deletions doc/features/pack/pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

### 简洁至上
简化各种多余界面元素, 专注于内容本身.
包含以下功能:
删除广告, 删除直播水印, 删除视频弹窗, 禁用特殊弹幕样式, 简化评论区, 简化直播间, 简化首页, 自动收起直播侧栏, 隐藏视频推荐, 隐藏直播推荐, 隐藏视频标题层, 自动隐藏侧栏

<details>
<summary><strong>jsDelivr Stable</strong></summary>
Expand Down Expand Up @@ -83,6 +85,8 @@ https://raw.githubusercontent.com/the1812/Bilibili-Evolved/preview/registry/dist

### 下载器
包含下载各种内容的功能.
包含以下功能:
下载视频, 下载字幕, 下载弹幕, 下载音频, 直播录像下载

<details>
<summary><strong>jsDelivr Stable</strong></summary>
Expand Down Expand Up @@ -135,6 +139,8 @@ https://raw.githubusercontent.com/the1812/Bilibili-Evolved/preview/registry/dist

### 常用功能包
包含一些常用功能.
包含以下功能:
使用细滚动条, 自定义顶栏, 删除广告, 专栏文字选择, 网址参数清理, 快捷键扩展, 查看封面, BV 号转换, 删除直播水印, 直播弹幕发送栏, 直播全屏包裹, 展开动态内容, 动态反折叠, 快速收起评论, 禁止跳转动态详情, 展开视频简介, 设置面板 - "最近使用" 类别

<details>
<summary><strong>jsDelivr Stable</strong></summary>
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
**预留给 Github Pages 的文件夹**

文档请放至`doc`文件夹
文档请放至 `doc` 文件夹
18 changes: 9 additions & 9 deletions registry/dist/doc.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion registry/lib/components/live/pip/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export const component: ComponentMetadata = {
name: 'livePip',
displayName: '直播画中画',
description: {
'zh-CN': '在直播间的功能中启用画中画支持.',
'zh-CN': '在直播间的功能面板中启用画中画支持, 不过现在好像 b 站已经直接支持了, 后续可能会删掉这个功能.',
},
entry: none,
tags: [
Expand Down
4 changes: 2 additions & 2 deletions registry/lib/components/live/showgirl/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ const entry = async () => {
}
export const component: ComponentMetadata = {
name: 'dpiLiveShowgirl',
displayName: '直播看板娘高DPI适配',
displayName: '直播看板娘高 DPI 适配',
enabledByDefault: window.devicePixelRatio > 1,
description: {
'zh-CN': '根据屏幕DPI缩放直播看板娘的大小, 避免像素锯齿.',
'zh-CN': '根据屏幕 DPI 缩放直播看板娘的大小, 避免像素锯齿.',
},
tags: [
componentsTags.live,
Expand Down
1 change: 1 addition & 0 deletions registry/lib/components/live/side-bar/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export const component: ComponentMetadata = {
},
],
displayName: '自动收起直播侧栏',
description: '自动收起直播间右边偏下的侧栏. (上面有个 "关注" 的面板)',
tags: [
componentsTags.live,
componentsTags.style,
Expand Down
2 changes: 1 addition & 1 deletion registry/lib/components/style/auto-hide-sidebar/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ export const component: ComponentMetadata = {
],
tags: [componentsTags.style, componentsTags.general],
description: {
'zh-CN': '自动隐藏脚本的侧栏(功能和设置图标). 设置面板停靠在右侧时不建议使用, 因为网页的滚动条会占用右边缘的触发区域.',
'zh-CN': '自动隐藏脚本的侧栏 (功能和设置图标). 设置面板停靠在右侧时不建议使用, 因为网页的滚动条会占用右边缘的触发区域.',
},
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ export const component: ComponentMetadata = {
],
description: {
'zh-CN': `
使夜间模式同步系统设置的亮/暗主题.
使夜间模式同步系统设置的亮 / 暗主题, 请勿和 \`夜间模式计划时段\` 一同使用.
> 注:在某些浏览器(如\`Microsoft Edge\`)中,夜间模式仅会同步浏览器的亮/暗主题.
> 注:在某些浏览器 (如 \`Microsoft Edge\`) 中,夜间模式仅会同步浏览器的亮 / 暗主题.
`.trim(),
},
}
2 changes: 1 addition & 1 deletion registry/lib/components/style/dark-mode/schedule/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ const checkTime = (settings: ComponentSettings) => {
export const component: ComponentMetadata = {
name: 'darkModeSchedule',
displayName: '夜间模式计划时段',
description: '设置一个使用夜间模式的时间段, 进入/离开此时间段时, 会自动开启/关闭夜间模式. 结束时间小于起始时间时将视为次日, 如`18:00``6:00`表示晚上18:00到次日6:00.',
description: '设置一个使用夜间模式的时间段, 进入 / 离开此时间段时, 会自动开启 / 关闭夜间模式. 结束时间小于起始时间时将视为次日, 如 `18:00``6:00` 表示晚上 18:00 到次日 6:00. 请勿和 \`夜间模式跟随系统\` 一同使用.',
tags: [
componentsTags.style,
componentsTags.general,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ export const component: ComponentMetadata = {
style: () => import('./recommended-live.scss'),
},
],
displayName: '隐藏推荐直播',
displayName: '隐藏直播推荐',
tags: [
componentsTags.style,
componentsTags.video,
],
description: {
'zh-CN': '隐藏视频页面右侧下方的推荐直播.',
'zh-CN': '隐藏视频页面右侧下方的直播推荐.',
},
urlInclude: videoUrls,
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const component: ComponentMetadata = {
componentsTags.video,
],
description: {
'zh-CN': '隐藏番剧和视频页面右侧的推荐视频列表. 注意: 如果你想关闭 b 站的自动连播(自动播放下一个推荐视频)功能, 需要先取消隐藏视频推荐才能看到开关.',
'zh-CN': '隐藏番剧和视频页面右侧的推荐视频列表. 注意: 如果你想关闭 b 站的自动连播 (自动播放下一个推荐视频) 功能, 需要先取消隐藏视频推荐才能看到开关.',
},
urlInclude: videoAndBangumiUrls,
}
1 change: 1 addition & 0 deletions registry/lib/components/style/scrollbar/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export const component: ComponentMetadata = {
name: 'elegantScrollbar',
entry: none,
displayName: '使用细滚动条',
description: '使用浏览器的滚动条风格替代系统的滚动条, 不过 macOS 系统滚动条比浏览器做得好一些, 因此不建议 macOS 使用此功能.',
tags: [
componentsTags.style,
componentsTags.general,
Expand Down
2 changes: 1 addition & 1 deletion registry/lib/components/style/simplify/comments/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export const component: ComponentMetadata = {
'zh-CN': `
- 删除热评头像下方的关注按钮
- 删除用户的等级标识
- 删除发送源信息(\`来自安卓客户端\`这种)
- 删除发送源信息(\`来自安卓客户端\` 这种)
- 删除用户名右边的勋章
- 删除评论区顶部的横幅
- 发送时间移动到右上角
Expand Down
6 changes: 5 additions & 1 deletion registry/lib/components/style/simplify/home/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@ const metadata: ComponentMetadata = {
name: 'simplifyHome',
displayName: '简化首页',
description: {
'zh-CN': '隐藏原版首页不需要的元素/分区.',
'zh-CN': `
隐藏原版首页不需要的元素 / 分区.
> 这个功能相当于 v1 的 \`首页过滤\`, v1 的 \`简化首页\` (清爽 / 极简首页) 需要重构后再发布, 问就是 Coming Soon.
`.trim(),
},
instantStyles: [
{
Expand Down
2 changes: 1 addition & 1 deletion registry/lib/components/style/special-danmaku/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const component: ComponentMetadata = {
...toggleStyle('disableSpecialDanmaku', () => import('./special-danmaku.scss'), entry),
urlInclude: playerUrls,
description: {
'zh-CN': '移除高赞弹幕或UP主弹幕的特殊样式, 弹幕内容不会移除.',
'zh-CN': '移除高赞弹幕或 UP 主弹幕的特殊样式, 弹幕内容不会移除.',
},
options: {
highlight: {
Expand Down
2 changes: 1 addition & 1 deletion registry/lib/components/touch/combo-like/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export const component: ComponentMetadata = {
enabledByDefault: navigator.maxTouchPoints > 0,
entry,
description: {
'zh-CN': '为视频页面中的三连操作(长按点赞)启用触摸支持.',
'zh-CN': '为视频页面中的三连操作 (长按点赞) 启用触摸支持.',
},
urlInclude: videoUrls,
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export const component: ComponentMetadata = {
name: 'doubleClickControl',
displayName: '启用双击控制',
description: {
'zh-CN': '将操作方式更改为: 单击显示/隐藏控制栏, 双击播放/暂停.',
'zh-CN': '将视频播放器的操作方式更改为: 单击显示 / 隐藏控制栏, 双击播放 / 暂停.',
},
tags: [
componentsTags.touch,
Expand Down
10 changes: 5 additions & 5 deletions registry/lib/components/utils/image-exporter/desc.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
可以批量导出某个地方的图片, 目前支持动态和专栏.

动态文件名变量:
`user`: 用户名
`id`: 动态 ID
`n`: 第 n 张图
- `user`: 用户名
- `id`: 动态 ID
- `n`: 第 n 张图

专栏文件名变量:
`title`: 专栏标题
`n`: 第 n 张图
- `title`: 专栏标题
- `n`: 第 n 张图
2 changes: 1 addition & 1 deletion registry/lib/components/utils/image-resolution/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export const component: ComponentMetadata = {
enabledByDefault: window.devicePixelRatio > 1,
entry: startResolution,
description: {
'zh-CN': '根据屏幕 DPI 请求更高分辨率的图片, 例如 DPI 缩放 200% 则请求 2 倍的分辨率, 加载时间也会相应变长一些.',
'zh-CN': '根据屏幕 DPI 请求更高分辨率的图片, 例如 DPI 缩放 200% 则请求 2 倍的分辨率, 加载时间也会相应变长一些. (也会导致某些浏览器里出现图片闪动, 因为本质上是更换了图片源)',
},
options: {
scale: {
Expand Down
2 changes: 1 addition & 1 deletion registry/lib/components/utils/keymap/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export const component: ComponentMetadata = {
unload: () => { config && (config.enable = false) },
reload: () => { config && (config.enable = true) },
description: {
'zh-CN': '为视频播放器启用更多的快捷键, 快捷键列表可在`快捷键设置`中查看和配置.',
'zh-CN': '为脚本的功能和 b 站的功能启用键盘快捷键支持, 快捷键列表可在`快捷键设置`中查看和配置.',
},
extraOptions: () => import('./settings/ExtraOptions.vue').then(m => m.default),
options: {
Expand Down
Loading

0 comments on commit d842469

Please sign in to comment.