update README.md
This commit is contained in:
nxxy335top
@@ -0,0 +1,27 @@
|
||||
# 归档
|
||||
|
||||
归档页面按时间线展示所有已发布的文章，方便读者按时间浏览。
|
||||
|
||||
## 页面布局
|
||||
|
||||
归档页面以年份和月份分组，形成清晰的时间线结构：
|
||||
|
||||
- 页面标题（默认「归档」，可在基础设置中自定义）
|
||||
- 文章总数统计
|
||||
- 按年月分组的时间线列表
|
||||
- 每个分组显示年份和月份
|
||||
- 每篇文章显示标题，可点击跳转
|
||||
|
||||
## 视觉设计
|
||||
|
||||
时间线采用圆点 + 竖线的经典设计：
|
||||
|
||||
- 每个月份分组左侧有圆点标记
|
||||
- 分组之间用竖线连接
|
||||
- 文章标题悬停时变为强调色
|
||||
- 支持分页导航
|
||||
|
||||
## 相关配置
|
||||
|
||||
- [基础设置](/config/basic) — 归档页标题文案
|
||||
- [首页配置](/config/home) — 文章数量文案模板
|
||||
@@ -0,0 +1,39 @@
|
||||
# 分类与标签
|
||||
|
||||
分类和标签是文章的两种组织方式，主题提供了独立的列表页面和详情页面。
|
||||
|
||||
## 分类列表页
|
||||
|
||||
展示所有分类，每个分类显示：
|
||||
|
||||
- 分类名称
|
||||
- 该分类下的文章数量
|
||||
- 可点击进入分类详情
|
||||
|
||||
## 分类详情页
|
||||
|
||||
展示某个分类下的所有文章，布局与首页文章列表类似。URL 格式为 `/categories/{slug}`。
|
||||
|
||||
## 标签列表页
|
||||
|
||||
展示所有标签，以标签云的形式呈现：
|
||||
|
||||
- 标签名称
|
||||
- 该标签下的文章数量
|
||||
- 可点击进入标签详情
|
||||
|
||||
## 标签详情页
|
||||
|
||||
展示某个标签下的所有文章。URL 格式为 `/tags/{slug}`。
|
||||
|
||||
## 使用方式
|
||||
|
||||
分类和标签在 Halo 后台的文章编辑器中设置：
|
||||
|
||||
1. 编辑文章时，在侧边栏中添加分类和标签
|
||||
2. 主题会自动读取并渲染分类/标签页面
|
||||
3. 通过菜单管理添加分类/标签页面的导航链接
|
||||
|
||||
::: tip
|
||||
建议在导航菜单中添加「分类」和「标签」的链接，方便访客浏览。分类链接为 `/categories`，标签链接为 `/tags`。
|
||||
:::
|
||||
@@ -0,0 +1,38 @@
|
||||
# 自定义页面
|
||||
|
||||
自定义页面是 Halo 的独立页面功能，用于创建关于、友链等独立内容页面。
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 进入 Halo 后台 → **页面** → **新建**
|
||||
2. 填写页面标题和内容
|
||||
3. 可选择自定义模板
|
||||
4. 发布页面
|
||||
|
||||
## 页面模板
|
||||
|
||||
主题提供以下自定义页面模板：
|
||||
|
||||
| 模板 | 文件 | 说明 |
|
||||
|------|------|------|
|
||||
| 默认 | page.html | 标准内容页面 |
|
||||
| 留言板 | page_messageboard.html | 带评论的留言板页面 |
|
||||
|
||||
### 留言板模板
|
||||
|
||||
选择留言板模板后，页面会自动集成评论组件，访客可以直接留言。标题和副标题使用主题设置中的配置。
|
||||
|
||||
使用步骤：
|
||||
|
||||
1. 新建页面，选择自定义模板为「留言板」
|
||||
2. 在主题设置 → 留言板中配置标题和副标题
|
||||
3. 发布页面，添加到导航菜单
|
||||
|
||||
## 页面功能
|
||||
|
||||
自定义页面支持：
|
||||
|
||||
- 富文本编辑器内容
|
||||
- 封面图
|
||||
- 评论组件
|
||||
- 自定义模板选择
|
||||
@@ -0,0 +1,41 @@
|
||||
# 扩展页面
|
||||
|
||||
WarmIsland 主题深度集成了多款 Halo 插件，提供了丰富的扩展页面。
|
||||
|
||||
## 支持的扩展页面
|
||||
|
||||
| 页面 | 所需插件 | 路由 |
|
||||
|------|----------|------|
|
||||
| 瞬间 | PluginMoments | /moments |
|
||||
| 图库 | PluginPhotos | /photos |
|
||||
| 友情链接 | PluginLinks | /links |
|
||||
| 朋友圈 | plugin-friends | /friends |
|
||||
| 豆瓣 | 豆瓣插件 | /douban |
|
||||
| 装备 | 装备插件 | /equipments |
|
||||
| 足迹 | 足迹插件 | /footprints |
|
||||
| Steam | Steam 插件 | /steam |
|
||||
|
||||
## 豆瓣页面
|
||||
|
||||
展示豆瓣观影/读书/音乐记录，支持按类型和状态筛选。
|
||||
|
||||
## 装备页面
|
||||
|
||||
展示个人装备清单，按分组分类展示。
|
||||
|
||||
## 足迹页面
|
||||
|
||||
展示个人足迹地图。
|
||||
|
||||
## Steam 页面
|
||||
|
||||
展示 Steam 游戏资料，包括：
|
||||
|
||||
- 玩家头像和昵称
|
||||
- 游戏统计
|
||||
- 徽章展示
|
||||
- 最近游戏
|
||||
|
||||
::: info
|
||||
扩展页面需要安装对应的 Halo 插件才能使用。如果插件未安装，页面会显示友好的提示信息。
|
||||
:::
|
||||
@@ -0,0 +1,25 @@
|
||||
# 朋友圈
|
||||
|
||||
朋友圈页面展示订阅的友站最新文章动态，需要安装 [朋友圈插件](https://www.halo.run/store/apps/app-friends)。
|
||||
|
||||
## 功能说明
|
||||
|
||||
页面以时间线形式展示友站更新，每条动态包含：
|
||||
|
||||
- 友站名称和头像
|
||||
- 文章标题和链接
|
||||
- 发布时间
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 在 Halo 后台安装并启用朋友圈插件
|
||||
2. 在插件设置中添加友站 RSS 订阅源
|
||||
3. 主题自动读取并展示友站动态
|
||||
|
||||
::: tip
|
||||
朋友圈插件负责数据抓取，主题负责前端展示。如需调整抓取频率或内容，请在插件设置中操作。
|
||||
:::
|
||||
|
||||
## 相关配置
|
||||
|
||||
- [朋友圈配置](/config/friends) — 页面标题
|
||||
@@ -0,0 +1,68 @@
|
||||
# 首页
|
||||
|
||||
首页是网站的入口，由 Hero 首屏、置顶文章和文章列表三个模块组成。
|
||||
|
||||
## 页面结构
|
||||
|
||||
首页从上到下依次为：
|
||||
|
||||
1. **Hero 首屏** — 全屏展示区（可通过 Hero 设置关闭）
|
||||
2. **置顶文章** — 显示置顶的文章，大卡片布局
|
||||
3. **文章列表** — 非置顶文章的流式布局
|
||||
|
||||
## Hero 首屏
|
||||
|
||||
Hero 区域占据整个视口高度，包含：
|
||||
|
||||
- **主标题**：默认使用站点标题，可在主题设置中自定义
|
||||
- **副标题**：默认使用站点副标题
|
||||
- **描述文案**：支持一言 API、自定义文案或关闭
|
||||
- **视觉效果**：渐变背景 + 呼吸光球 + 滚动模糊
|
||||
|
||||
页面滚动时，Hero 区域会产生模糊效果，内容向上淡出，底部有向下箭头提示滚动。
|
||||
|
||||
Hero 设置详见 [Hero 首屏配置](/config/hero)。
|
||||
|
||||
## 置顶文章
|
||||
|
||||
在 Halo 后台将文章设置为「置顶」后，该文章会出现在首页置顶区域：
|
||||
|
||||
- 单篇置顶：全宽大卡片展示
|
||||
- 多篇置顶：两列网格布局
|
||||
- 显示分类、日期、标题和摘要
|
||||
- 支持封面图，悬停时图片微缩放
|
||||
|
||||
## 文章列表
|
||||
|
||||
非置顶文章以流式卡片布局展示：
|
||||
|
||||
- **有封面图**：左侧内容 + 右侧缩略图
|
||||
- **无封面图**：纯文字布局
|
||||
- **移动端**：统一为上下布局
|
||||
|
||||
每张卡片显示以下信息（均可通过主题设置控制显隐）：
|
||||
|
||||
- 分类标签
|
||||
- 发布日期
|
||||
- 文章标题
|
||||
- 文章摘要（可配置行数）
|
||||
- 标签列表
|
||||
- 阅读量
|
||||
|
||||
## 文章加载方式
|
||||
|
||||
支持两种加载方式，在 [首页配置](/config/home) 中设置：
|
||||
|
||||
### 分页
|
||||
|
||||
传统翻页导航，页面底部显示「较新」「较旧」按钮和页码信息。
|
||||
|
||||
### 无限滚动
|
||||
|
||||
滚动到页面底部时自动加载下一页文章，新文章以渐入动画出现。加载过程中显示旋转加载指示器，全部加载完毕后显示提示文案。
|
||||
|
||||
## 相关配置
|
||||
|
||||
- [首页配置](/config/home) — 置顶/文章模块、卡片显示项、加载方式
|
||||
- [Hero 首屏配置](/config/hero) — 标题、描述、视觉效果
|
||||
- [样式设置](/config/style) — 配色、圆角、动画
|
||||
@@ -0,0 +1,31 @@
|
||||
# 友情链接
|
||||
|
||||
友情链接页面展示友站信息，需要安装 [链接管理插件](https://www.halo.run/store/apps/app-links)。
|
||||
|
||||
## 展示样式
|
||||
|
||||
主题提供三种友链展示样式，在 [友情链接配置](/config/links) 中设置：
|
||||
|
||||
### Cards（卡片）
|
||||
|
||||
默认样式，每个友链以卡片形式展示，包含头像、名称和描述。视觉效果丰富。
|
||||
|
||||
### Grid（网格）
|
||||
|
||||
紧凑的网格布局，以图标和名称为主，适合友链数量较多的站点。
|
||||
|
||||
### List（列表）
|
||||
|
||||
列表布局，每行一个友链，信息密度适中。
|
||||
|
||||
## 友链管理
|
||||
|
||||
友情链接通过 Halo 后台的 **链接** 管理功能添加：
|
||||
|
||||
1. 进入 Halo 后台 → **链接** → **新建**
|
||||
2. 填写链接名称、URL、描述和头像
|
||||
3. 可将链接分组，主题会按分组展示
|
||||
|
||||
## 相关配置
|
||||
|
||||
- [友情链接配置](/config/links) — 展示样式
|
||||
@@ -0,0 +1,35 @@
|
||||
# 瞬间
|
||||
|
||||
瞬间页面展示短内容动态，需要安装 [瞬间插件](https://www.halo.run/store/apps/app-moments)。
|
||||
|
||||
## 展示样式
|
||||
|
||||
主题提供三种瞬间展示样式，在 [瞬间配置](/config/moments) 中设置：
|
||||
|
||||
### Timeline（时间线）
|
||||
|
||||
默认样式，左侧竖线 + 圆点的时间线布局，每条瞬间以卡片形式展示。适合按时间顺序浏览。
|
||||
|
||||
### Cards（卡片）
|
||||
|
||||
网格卡片布局，使用毛玻璃效果背景。适合图片较多的瞬间。
|
||||
|
||||
### Masonry（瀑布流）
|
||||
|
||||
瀑布流多列布局，自动适应内容高度。适合内容长度不一的混合瞬间。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 支持图片展示（多图自动网格布局，单图大图展示）
|
||||
- 支持点赞功能
|
||||
- 支持评论功能（点击评论按钮展开评论区）
|
||||
- 支持无限滚动或分页加载
|
||||
- 图片点击放大（灯箱效果）
|
||||
|
||||
## 插件依赖
|
||||
|
||||
如果未安装瞬间插件，页面会显示友好的提示信息：「瞬间功能需要安装「瞬间」插件，前往应用市场安装」。
|
||||
|
||||
## 相关配置
|
||||
|
||||
- [瞬间配置](/config/moments) — 展示样式、加载方式、每页数量
|
||||
@@ -0,0 +1,36 @@
|
||||
# 图库
|
||||
|
||||
图库页面展示照片集，需要安装 [图库插件](https://www.halo.run/store/apps/app-photos)。
|
||||
|
||||
## 展示样式
|
||||
|
||||
主题提供三种图库展示样式，在 [图库配置](/config/photos) 中设置：
|
||||
|
||||
### Masonry（瀑布流）
|
||||
|
||||
默认样式，图片以瀑布流方式排列，自动适应不同尺寸，视觉效果自然流畅。
|
||||
|
||||
### Grid（网格）
|
||||
|
||||
等高网格布局，所有图片统一裁剪为相同尺寸，整齐划一。
|
||||
|
||||
### Carousel（轮播）
|
||||
|
||||
轮播展示，适合精选照片展示。
|
||||
|
||||
## 分组浏览
|
||||
|
||||
图库支持分组浏览：
|
||||
|
||||
- 顶部显示分组标签栏，可切换不同分组
|
||||
- 「全部」视图显示所有分组的图片
|
||||
- 可选择是否显示分组标题
|
||||
- 可选择是否显示未分组图片
|
||||
|
||||
## 灯箱效果
|
||||
|
||||
点击图片会打开灯箱全屏查看，支持左右切换和关闭操作。
|
||||
|
||||
## 相关配置
|
||||
|
||||
- [图库配置](/config/photos) — 展示样式、列数、分组设置
|
||||
@@ -0,0 +1,61 @@
|
||||
# 文章详情
|
||||
|
||||
文章详情页是阅读体验的核心页面，提供沉浸式的阅读环境。
|
||||
|
||||
## 页面元素
|
||||
|
||||
文章详情页包含以下元素（从上到下）：
|
||||
|
||||
1. **阅读进度条** — 页面顶部的进度指示条
|
||||
2. **封面图** — 文章封面（可配置显隐）
|
||||
3. **文章标题** — 大号标题 + 强调线装饰
|
||||
4. **元信息** — 日期、作者、分类、标签、字数、阅读量
|
||||
5. **正文内容** — 文章主体
|
||||
6. **文章目录** — 侧边悬浮（桌面端）或底部抽屉（移动端）
|
||||
7. **点赞按钮** — 文章底部的爱心点赞
|
||||
8. **上下篇导航** — 上一篇/下一篇文章
|
||||
9. **评论区** — Halo 评论组件
|
||||
|
||||
## 阅读进度条
|
||||
|
||||
页面顶部有一条细进度条，宽度随滚动位置实时更新，帮助读者了解当前阅读进度。进度条使用强调色显示。
|
||||
|
||||
## 文章目录（TOC）
|
||||
|
||||
目录自动从文章内容的标题（h1-h6）中提取生成。
|
||||
|
||||
### 桌面端（1280px+）
|
||||
|
||||
目录以固定侧边栏形式显示在文章旁边，位置可选左侧或右侧。目录会跟随滚动高亮当前标题，支持点击跳转。当屏幕空间不足以容纳目录时，目录自动隐藏。
|
||||
|
||||
### 移动端（<1280px）
|
||||
|
||||
目录隐藏，右下角显示目录悬浮按钮（FAB），点击后从底部弹出目录抽屉面板。抽屉内目录项可点击跳转，点击遮罩层或关闭按钮关闭抽屉。
|
||||
|
||||
## 代码高亮
|
||||
|
||||
使用 Prism.js 实现代码块语法高亮，支持自动语言检测。可在主题设置中选择两种主题：
|
||||
|
||||
- **Warm**：浅色代码高亮，与暖色调设计一致
|
||||
- **Cold**：深色代码高亮（Tomorrow Night），适合代码密集型文章
|
||||
|
||||
## 图片灯箱
|
||||
|
||||
文章中的图片支持点击放大查看，使用 LightGallery 实现。放大后支持左右切换、缩放和关闭操作。
|
||||
|
||||
## 点赞功能
|
||||
|
||||
文章底部的点赞按钮使用 Halo 内置 API：
|
||||
|
||||
- 点赞后按钮变为高亮状态，显示爱心填充图标
|
||||
- 同一文章不可重复点赞（基于 localStorage 判断）
|
||||
- 点赞数实时更新
|
||||
|
||||
## 上下篇导航
|
||||
|
||||
文章底部显示上一篇和下一篇文章的链接，帮助读者连续浏览。可通过主题设置控制显隐。
|
||||
|
||||
## 相关配置
|
||||
|
||||
- [文章配置](/config/article) — 封面图、目录、代码高亮、点赞等
|
||||
- [评论配置](/config/comment) — 评论样式和头像显示
|
||||
Reference in New Issue
Block a user