feat(v1.2.7): 全面校准文档并精简三个可选 API 配置项文案

- 文档对齐 1.2.7:feed/RSS 聚合改由官方链接管理插件订阅承担、Halo 要求统一 >=2.27.0、补齐设置分组文档、清理与代码不符的描述,并修复正文引用块留白
- 三个可选 API 设置项 help 只保留功能说明,隐私披露统一由 README「外部资源与隐私」与文档站承载;字段恢复按开关条件显示,修正配置块缩进
- audit:external 改为防回潮检查:字段存在、help 不得出现披露文案、README 必须保留隐私披露章节
This commit is contained in:
nxxy335 committed 2026-11-11 22:34:32 +08:00
1 parent c92429d139
commit 5c7c6325b1
34 files changed
+500 -210

No files matched your search

+30 -13
View File
@@ -1,32 +1,49 @@
# 自定义页面
自定义页面是 Halo 的独立页面功能,用于创建关于、友链等独立内容页面。
自定义页面是 Halo 的独立页面功能,用于创建关于、留言板、订阅动态、微信读书等独立内容页面。
## 使用方式
1. 进入 Halo 后台 → **页面** → **新建**
2. 填写页面标题和内容
3. 可选择自定义模板
4. 发布页面
3. 可选:在「自定义模板」中选择主题提供的模板
4. 发布页面,并把页面加入导航菜单
页面地址由创建时设定的 slug 决定,主题不为自定义模板提供固定路由。
## 页面模板
主题提供以下自定义页面模板:
`theme.yaml` 中注册了 3 个自定义模板,加上默认的 `page.html` 共 4 种:
| 模板 | 文件 | 说明 |
|------|------|------|
| 默认 | page.html | 标准内容页面 |
| 留言板 | page_messageboard.html | 带评论的留言板页面 |
| 模板 | 模板文件 | 说明 |
|------|---------|------|
| 默认 | `page.html` | 标准内容页面 |
| 留言板(MessageBoard) | `page_messageboard.html` | 带评论的留言墙,标题与副标题可配置 |
| 订阅(Subscriptions) | `page_subscriptions.html` | 博友文章订阅动态,依赖官方「链接管理」插件的 RSS 订阅 |
| 微信读书(WeRead) | `weread.html` | 微信读书书架,依赖微信读书插件,访客免登录查看 |
### 留言板模板
选择留言板模板后,页面会自动集成评论组件,访客可以直接留言。标题和副标题使用主题设置中的配置。
选择留言板模板后,页面会集成评论组件,访客可以直接留言。标题和副标题在
**主题设置 → 留言板** 中配置,详见[留言板配置](/config/messageboard)。
使用步骤:
### 订阅模板
1. 新建页面,选择自定义模板为「留言板」
2. 在主题设置 → 留言板中配置标题和副标题
3. 发布页面,添加到导航菜单
feed / RSS 聚合不再依赖已停止提供的「朋友圈」插件,而由官方
「链接管理」(PluginLinks)插件的订阅能力提供。使用步骤:
1. 安装并启用[链接管理插件](https://www.halo.run/store/apps/app-hfbQg),维护博友链接的 RSS 订阅源
2. 新建页面,自定义模板选择「订阅」
3. 在**主题设置 → 订阅**中调整每页条数、加载方式与布局,详见[订阅配置](/config/subscriptions)
未安装插件或暂无订阅动态时页面会显示友好提示,不会报错。
完整说明见[订阅页面](/pages/subscriptions)。
### 微信读书模板
选择「微信读书」模板后展示书架与阅读记录,标题 / 副标题在
**主题设置 → 微信读书** 中配置,详见[微信读书配置](/config/weread)。
该页面依赖 Halo 2.27+ 的能力。
## 页面功能
+25 -20
View File
@@ -6,31 +6,37 @@ WarmIsland 主题深度集成了多款 Halo 插件,提供了丰富的扩展页
| 页面 | 所需插件 | 路由 |
|------|----------|------|
| 瞬间 | [PluginMoments](https://www.halo.run/store/apps/app-SnwWD) | /moments |
| 图库 | [PluginPhotos](https://www.halo.run/store/apps/app-BmQJW) | /photos |
| 友情链接 | [PluginLinks](https://www.halo.run/store/apps/app-hfbQg) | /links |
| 朋友圈 | [plugin-friends](https://www.halo.run/store/apps/app-yISsV) | /friends |
| 豆瓣 | [plugin-douban](https://www.halo.run/store/apps/app-srBOL) | /douban |
| 装备 | [equipment](https://www.halo.run/store/apps/app-ytygyqml) | /equipments |
| 足迹 | [footprint](https://www.halo.run/store/apps/app-XCtAQ) | /footprints |
| Steam | [steam](https://www.halo.run/store/apps/app-0ojqyzfh) | /steam |
| 记得 | [plugin-important-dates](https://github.com/yyliucha/plugin-important-dates) | /important-dates |
| 瞬间 | [PluginMoments](https://www.halo.run/store/apps/app-SnwWD) | `/moments` |
| 图库 | [PluginPhotos](https://www.halo.run/store/apps/app-BmQJW) | `/photos` |
| 友情链接 | [PluginLinks](https://www.halo.run/store/apps/app-hfbQg) | `/links` |
| 订阅动态 | [PluginLinks](https://www.halo.run/store/apps/app-hfbQg)(RSS 订阅) | 自定义页面,无固定路由 |
| 豆瓣 | [plugin-douban](https://www.halo.run/store/apps/app-srBOL) | `/douban` |
| 装备 | [equipment](https://www.halo.run/store/apps/app-ytygyqml) | `/equipments` |
| Steam | [steam](https://www.halo.run/store/apps/app-0ojqyzfh) | `/steam` |
| 记得 | [plugin-important-dates](https://github.com/yyliucha/plugin-important-dates) | `/important-dates` |
> 「朋友圈」(`plugin-friends`)插件已不再提供,其 feed / RSS 聚合能力由官方「链接管理」插件的订阅取代。
> 主题保留的 `friends.html` 仅供旧站点兼容,新站点请使用订阅模板,详见[订阅页面](/pages/subscriptions)。
## 订阅页面
订阅页面依赖官方「链接管理」插件的 RSS 订阅,展示博友们的最新文章,
支持分页 / 下滑加载与列表 / 网格布局。它属于自定义页面模板,地址由你创建页面时的 slug 决定。
使用前请在 Halo 后台 → 页面 → 新建 → 自定义模板中选择「订阅」。
详见[订阅页面](/pages/subscriptions)与[订阅配置](/config/subscriptions)。
## 豆瓣页面
[豆瓣插件](https://www.halo.run/store/apps/app-srBOL)
展示豆瓣观影/读书/音乐记录,支持按类型和状态筛选。
[豆瓣插件](https://www.halo.run/store/apps/app-srBOL)展示豆瓣观影/读书/音乐记录,支持按类型和状态筛选。
## 装备页面
[装备管理插件](https://www.halo.run/store/apps/app-ytygyqml)
展示个人装备清单,按分组分类展示。
## 足迹页面
[足迹插件](https://www.halo.run/store/apps/app-XCtAQ)
展示个人足迹地图。
[装备管理插件](https://www.halo.run/store/apps/app-ytygyqml)展示个人装备清单,按分组分类展示。
## Steam 页面
[Steam](https://www.halo.run/store/apps/app-0ojqyzfh)
展示 Steam 游戏资料,包括:
[Steam](https://www.halo.run/store/apps/app-0ojqyzfh)展示 Steam 游戏资料,包括:
- 玩家头像和昵称
- 游戏统计
@@ -39,8 +45,7 @@ WarmIsland 主题深度集成了多款 Halo 插件,提供了丰富的扩展页
## 记得页面
[记得插件](https://github.com/yyliucha/plugin-important-dates)
记录重要的日子、牵挂的人与座驾,「生活 / 爱车」双视图展示:
[记得插件](https://github.com/yyliucha/plugin-important-dates)记录重要的日子、牵挂的人与座驾,「生活 / 爱车」双视图展示:
- 重要日期(含农历)与倒计时便签
- 牵挂的人:大头贴、昵称、关系与生日倒计时
-25
View File
@@ -1,25 +0,0 @@
# 朋友圈
朋友圈页面展示订阅的友站最新文章动态,需要安装 [朋友圈插件](https://www.halo.run/store/apps/app-yISsV)。
## 功能说明
页面以时间线形式展示友站更新,每条动态包含:
- 友站名称和头像
- 文章标题和链接
- 发布时间
## 使用方式
1. 在 Halo 后台安装并启用朋友圈插件
2. 在插件设置中添加友站 RSS 订阅源
3. 主题自动读取并展示友站动态
::: tip
朋友圈插件负责数据抓取,主题负责前端展示。如需调整抓取频率或内容,请在插件设置中操作。
:::
## 相关配置
- [朋友圈配置](/config/friends) — 页面标题
+1 -1
View File
@@ -16,7 +16,7 @@ Hero 区域占据整个视口高度,包含:
- **主标题**:默认使用站点标题,可在主题设置中自定义
- **副标题**:默认使用站点副标题
- **描述文案**:默认「无」(不显示、零请求);可选「一言」(自动填入 `https://v1.hitokoto.cn/`,清空则用内置本地句子库)或「自定义」静态文案
- **描述文案**:默认「无」(不显示、零请求);可选「一言」(API 字段默认预填 `https://v1.hitokoto.cn/`,清空则用内置本地句子库)或「自定义」静态文案
- **视觉效果**:渐变背景 + 呼吸光球 + 滚动模糊
页面滚动时,Hero 区域会产生模糊效果,内容向上淡出,底部有向下箭头提示滚动。
+2
View File
@@ -29,3 +29,5 @@
## 相关配置
- [友情链接配置](/config/links) — 展示样式
- [订阅配置](/config/subscriptions) — 同一插件提供的 RSS 订阅动态
- [订阅页面](/pages/subscriptions) — 博友文章动态页面
+53
View File
@@ -0,0 +1,53 @@
# 订阅页面
订阅页面按时间倒序展示博友们的最新文章,即原先「朋友圈 / feed 聚合」所提供的能力。
现在它由 **Halo 官方「链接管理」(PluginLinks)插件的 RSS 订阅**驱动,主题提供
`page_subscriptions.html` 自定义模板负责前端展示。
## 使用方式
1. 安装并启用 [链接管理插件](https://www.halo.run/store/apps/app-hfbQg),在插件中维护博友链接的 RSS 订阅源
2. 进入 Halo 后台 → **页面** → **新建**
3. 选择自定义模板「**订阅**」(`Subscriptions`,对应 `page_subscriptions.html`)
4. 发布页面,并按需加入导航菜单
> 页面地址由你创建页面时设定的 slug 决定,主题**不提供固定的 `/subscriptions` 路由**;
> 只有插件提供的扩展页面(如 `/links`、`/moments`)才是固定路由。
## 页面内容
每条订阅动态是一张卡片,包含:
- 作者头像(缺失时显示首字占位)、作者名称与主页链接
- 发布日期
- 文章标题(点击跳转原文)、摘要
- 空数据时的友好提示,以及未安装链接管理插件时的安装引导
标题与作者链接均使用 `target="_blank"` + `rel="noopener noreferrer"`,
主题本身不会向第三方发起请求。
## 展示与加载
在[订阅配置](/config/subscriptions)中可调:
| 能力 | 可选值 |
| --- | --- |
| 布局 | 单列列表卡片 / 网格卡片(窄屏自动收敛列数) |
| 加载方式 | 底部分页(较新 / 较旧)/ 下滑自动加载 |
| 每页条数 | 1–100,默认 20 |
| 标题与副标题 | 自定义文本 |
## 从「朋友圈」迁移
`plugin-friends`(朋友圈)插件已不再提供,原来的 `/friends` 页面与「朋友圈」设置分组
仅作为旧站点兼容保留,模板检测到插件不可用时会显示空状态。迁移步骤:
1. 安装 / 启用「链接管理」插件,把原本在朋友圈插件里维护的 RSS 订阅源迁到链接管理插件的订阅中
2. 新建一个页面并选择「订阅」自定义模板
3. 确认动态正常展示后,删除旧的 `/friends` 页面与菜单项
## 相关配置
- [订阅配置](/config/subscriptions) — 全部 5 个设置项
- [友情链接页面](/pages/links) — 同一插件的友链展示
- [扩展页面](/pages/extended) — 插件前台页面一览