diff --git a/README.md b/README.md index 0ac5ed1..fbb6832 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ 一款简洁, 复古的 Terminal 风格 Halo 主题 + +  ## 功能 @@ -41,7 +43,7 @@ | 朋友圈 | `templates/friends.html`, 需要朋友圈插件 | | 瞬间 | `templates/moments.html`, 需要瞬间插件 | | 项目作品集 | `templates/portfolio.html`, `templates/portfolio-detail.html`, 需要作品集插件 | -| 搜索 | 搜索组件可用且开启页头搜索按钮时显示 | +| 搜索 | 搜索组件可用且开启页头搜索按钮时显示 | | 评论 | 启用评论插件并开启评论功能时显示评论组件 | | 错误页 | 提供 `404`, `5xx` 和通用错误模板 | @@ -49,38 +51,38 @@ ### 通用设置 -| 设置 | 配置名 | 说明 | -|----------|--------------------------------------------------|-----------------------------------------| -| 时间格式 | `general.time_style`, `general.custom_time_style` | 支持预设格式或自定义 Java 时间格式字符串 | -| 偏好有效期 | `general.prefer_ttl` | 访客偏好的保存小时数, `0` 表示永久保存 | -| PJAX | `general.pjax_enable` | 默认关闭, 开启后站内链接只更新主要内容 | +| 设置 | 配置名 | 说明 | +|-------|---------------------------------------------------|-------------------------| +| 时间格式 | `general.time_style`, `general.custom_time_style` | 支持预设格式或自定义 Java 时间格式字符串 | +| 偏好有效期 | `general.prefer_ttl` | 访客偏好的保存小时数, `0` 表示永久保存 | +| PJAX | `general.pjax_enable` | 默认关闭, 开启后站内链接只更新主要内容 | 访客手动选择的外观模式, 配色和像素风格会保存在浏览器的 `localStorage` 中. 默认有效期为 24 小时, 偏好过期后会在下次访问时恢复主题默认值. 已有但没有过期时间的偏好会在升级后的首次访问时开始计算有效期. ### 页头 -| 设置 | 配置名 | 说明 | -|----------|----------------------------------------------|---------------------------------| -| Logo 文本 | `header.logo` | 留空时使用 Halo 站点标题 | -| 搜索按钮 | `header.search_button_enable` | 搜索组件插件可用时展示 | -| 配色切换按钮 | `header.color_scheme_switcher_enable` | 展示自动发现的配色列表 | -| 深浅切换按钮 | `header.appearance_switcher_enable` | 在浅色, 深色和跟随系统之间循环 | -| 像素化按钮 | `header.pixel_style_switcher_enable` | 切换像素字体和像素图标 | +| 设置 | 配置名 | 说明 | +|---------|---------------------------------------|------------------| +| Logo 文本 | `header.logo` | 留空时使用 Halo 站点标题 | +| 搜索按钮 | `header.search_button_enable` | 搜索组件插件可用时展示 | +| 配色切换按钮 | `header.color_scheme_switcher_enable` | 展示自动发现的配色列表 | +| 深浅切换按钮 | `header.appearance_switcher_enable` | 在浅色, 深色和跟随系统之间循环 | +| 像素化按钮 | `header.pixel_style_switcher_enable` | 切换像素字体和像素图标 | 外观切换顺序为 `浅色 -> 深色 -> 跟随系统`; 图标依次为太阳, 月亮和圆圈. 切换外观模式时会清除访客单独选择的配色, 让浅色和深色模式重新使用主题设置中对应的方案. ### 字体与排版 -| 设置 | 配置名 | 说明 | -|----------|--------------------------------------|-----------------------------------------| -| 默认字体 | `typography.default_font` | 系统字体, JetBrains Mono, Hack 或 Fira Code | -| 自定义字体 | `typography.custom_font_enable` | 启用自定义字体列表 | -| 字体列表 | `typography.custom_fonts` | 按顺序组成字体 fallback | -| 字体大小 | `typography.font_size` | 接受 `16px`, `1rem` 等 CSS 长度 | -| 行高 | `typography.line_height` | 接受 CSS 长度或 `calc(...)` | -| 段落间距 | `typography.post_paragraph_spacing` | 控制文章正文段落的上下间距 | +| 设置 | 配置名 | 说明 | +|-------|-------------------------------------|----------------------------------------| +| 默认字体 | `typography.default_font` | 系统字体, JetBrains Mono, Hack 或 Fira Code | +| 自定义字体 | `typography.custom_font_enable` | 启用自定义字体列表 | +| 字体列表 | `typography.custom_fonts` | 按顺序组成字体 fallback | +| 字体大小 | `typography.font_size` | 接受 `16px`, `1rem` 等 CSS 长度 | +| 行高 | `typography.line_height` | 接受 CSS 长度或 `calc(...)` | +| 段落间距 | `typography.post_paragraph_spacing` | 控制文章正文段落的上下间距 | 每项自定义字体可以填写字体名称, PostScript Name, 字体文件和格式. 浏览器会先用 PostScript Name 匹配本地字体, 未命中时再加载文件. 高级设置支持字重, 样式, Unicode 范围, 显示策略, OpenType 特性, @@ -94,22 +96,22 @@ ### 布局 -| 设置 | 配置名 | 说明 | -|----------|-----------------------------|---------------------------------| -| 全屏布局 | `layout.fullscreen_layout` | 正文使用全部可用宽度 | -| 正文最大宽度 | `layout.max_width` | 接受 `960px`, `80vw` 等 CSS 长度 | -| 正文内边距 | `layout.content_padding` | 同时控制桌面端和移动端正文内边距 | -| 媒体最大宽度 | `layout.media_max_width` | 全屏布局中控制图片, 视频和 `figure` 宽度 | -| 表格铺满正文 | `layout.table_full_width` | 让正文中的表格宽度为 `100%` | +| 设置 | 配置名 | 说明 | +|--------|----------------------------|-----------------------------| +| 全屏布局 | `layout.fullscreen_layout` | 正文使用全部可用宽度 | +| 正文最大宽度 | `layout.max_width` | 接受 `960px`, `80vw` 等 CSS 长度 | +| 正文内边距 | `layout.content_padding` | 同时控制桌面端和移动端正文内边距 | +| 媒体最大宽度 | `layout.media_max_width` | 全屏布局中控制图片, 视频和 `figure` 宽度 | +| 表格铺满正文 | `layout.table_full_width` | 让正文中的表格宽度为 `100%` | ### 配色 -| 设置 | 配置名 | 说明 | -|---------|----------------------------------------------|---------------------------------| -| 默认外观 | `color_scheme.default_appearance` | 可选浅色, 深色或跟随系统 | -| 浅色方案 | `color_scheme.light_color_scheme` | 浅色模式使用的内置或自定义配色 | -| 深色方案 | `color_scheme.dark_color_scheme` | 深色模式使用的内置或自定义配色 | -| 自定义方案 | `color_scheme.custom_color_schemes` | 添加多套自定义配色 | +| 设置 | 配置名 | 说明 | +|-------|-------------------------------------|-----------------| +| 默认外观 | `color_scheme.default_appearance` | 可选浅色, 深色或跟随系统 | +| 浅色方案 | `color_scheme.light_color_scheme` | 浅色模式使用的内置或自定义配色 | +| 深色方案 | `color_scheme.dark_color_scheme` | 深色模式使用的内置或自定义配色 | +| 自定义方案 | `color_scheme.custom_color_schemes` | 添加多套自定义配色 | 浅色或深色方案选择 `custom` 时, 分别通过 `color_scheme.custom_light_scheme` 或 `color_scheme.custom_dark_scheme` 填写自定义方案 ID. 自定义方案至少需要 ID, 背景色, 主文本色和基础强调色; @@ -120,14 +122,14 @@ ### 全局样式 -| 设置 | 配置名 | 说明 | -|----------|------------------------------------------------------------|---------------------------------------------------| -| 默认像素风格 | `global_style.pixel_style` | 使用像素字体和像素图标 | -| 列表标记 | `global_style.list_style` | 接受 CSS `list-style` 值 | -| 通用边线 | `global_style.border_width`, `global_style.border_style` | 控制通用边线宽度和样式 | -| 表格边线 | `global_style.table_border_width`, `global_style.table_border_style` | 控制表格边线宽度和样式 | -| 标题分隔线 | `global_style.title_divider_style` | 可选 `solid`, `dashed`, `dotted`, `double` 或 `none` | -| 元信息分隔符 | `global_style.post_meta_divider` | 控制时间, 作者和标签等元信息之间的分隔符 | +| 设置 | 配置名 | 说明 | +|--------|----------------------------------------------------------------------|---------------------------------------------------| +| 默认像素风格 | `global_style.pixel_style` | 使用像素字体和像素图标 | +| 列表标记 | `global_style.list_style` | 接受 CSS `list-style` 值 | +| 通用边线 | `global_style.border_width`, `global_style.border_style` | 控制通用边线宽度和样式 | +| 表格边线 | `global_style.table_border_width`, `global_style.table_border_style` | 控制表格边线宽度和样式 | +| 标题分隔线 | `global_style.title_divider_style` | 可选 `solid`, `dashed`, `dotted`, `double` 或 `none` | +| 元信息分隔符 | `global_style.post_meta_divider` | 控制时间, 作者和标签等元信息之间的分隔符 | ### 高级设置 @@ -139,25 +141,17 @@ |-----|-----------------------------------| | 首页 | 公告标题, 公告内容, 社交资料, 置顶图标, 图标位置和文章标签 | | 文章页 | 文章目录, 目录默认状态和文章标签 | -| 归档页 | 页面标题和文章标签 | +| 归档页 | 页面标题, 文章标签, 分页和年份展开模式 | | 分类页 | 分类列表标题和分类详情标题 | | 标签页 | 标签列表标题和标签详情标题 | | 友链页 | 页面标题 | -文章目录会读取正文中的 `h1` 到 `h4`, `auto` 模式在普通布局中默认展开, 在全屏布局中默认收起, 目录也会根据浏览器宽度和正文右侧空间调整位置 +文章目录会读取正文中的 `h1` 到 `h4`, `auto` 模式在普通布局中默认展开, 在全屏布局中默认收起, 目录也会根据浏览器宽度和正文右侧空间调整位置. ### 社交资料 -首页可以显示以下资料: - -- Email -- GitHub -- Discord -- Telegram -- Facebook -- Instagram -- X -- RSS +首页可以添加任意社交资料. 每项资料可配置普通图标, 像素风格图标, 名称和链接; 链接支持 +`http://`, `https://`, `mailto:` 和 `tel:`. RSS 可单独开启. ### 备案信息 @@ -230,33 +224,33 @@ html[data-theme-color-scheme='matrix'] { ### 常用颜色变量 -| 变量 | 用途 | -|----------------------------------|----------------------------| -| `--color-theme-background` | 页面和基础背景 | -| `--color-theme-text` | 正文和主要文字 | -| `--color-theme-text-secondary` | 摘要, 插件等辅助文字 | -| `--color-theme-text-muted` | 时间, 作者, 占位符等弱化文字 | -| `--color-theme-text-inverse` | 强调色填充背景上的文字 | -| `--color-theme-accent` | 基础强调色, 用于填充和焦点等强调基础 | -| `--color-theme-text-accent` | 标题, 按钮文字等强调文字 | -| `--color-theme-text-label` | 标签和技术标记文字 | -| `--color-theme-text-link` | 普通链接文字 | -| `--color-theme-accent-muted` | 中等强度强调色 | -| `--color-theme-accent-subtle` | 低强度强调色 | -| `--color-theme-navigation` | 主导航文字 | -| `--color-theme-control` | 页头控件和 Logo | -| `--color-theme-surface` | 代码块和组件表面 | -| `--color-theme-surface-strong` | 对比度更高的代码和控件表面 | -| `--color-theme-border` | 默认边框 | -| `--color-theme-border-muted` | 低对比度边框 | -| `--color-theme-border-accent` | 交互元素和内容强调边框 | -| `--color-theme-border-emphasis` | 公告框, 作品卡片等强调边框 | -| `--color-theme-selection` | 选中文字的背景 | -| `--color-theme-overlay` | 模态遮罩层 | -| `--color-theme-scrollbar` | 滚动条 | -| `--color-theme-code-text` | 行内代码和代码块文字 | -| `--color-theme-code-background` | 行内代码背景 | -| `--color-theme-caret` | 打字效果动态光标 | +| 变量 | 用途 | +|---------------------------------|---------------------| +| `--color-theme-background` | 页面和基础背景 | +| `--color-theme-text` | 正文和主要文字 | +| `--color-theme-text-secondary` | 摘要, 插件等辅助文字 | +| `--color-theme-text-muted` | 时间, 作者, 占位符等弱化文字 | +| `--color-theme-text-inverse` | 强调色填充背景上的文字 | +| `--color-theme-accent` | 基础强调色, 用于填充和焦点等强调基础 | +| `--color-theme-text-accent` | 标题, 按钮文字等强调文字 | +| `--color-theme-text-label` | 标签和技术标记文字 | +| `--color-theme-text-link` | 普通链接文字 | +| `--color-theme-accent-muted` | 中等强度强调色 | +| `--color-theme-accent-subtle` | 低强度强调色 | +| `--color-theme-navigation` | 主导航文字 | +| `--color-theme-control` | 页头控件和 Logo | +| `--color-theme-surface` | 代码块和组件表面 | +| `--color-theme-surface-strong` | 对比度更高的代码和控件表面 | +| `--color-theme-border` | 默认边框 | +| `--color-theme-border-muted` | 低对比度边框 | +| `--color-theme-border-accent` | 交互元素和内容强调边框 | +| `--color-theme-border-emphasis` | 公告框, 作品卡片等强调边框 | +| `--color-theme-selection` | 选中文字的背景 | +| `--color-theme-overlay` | 模态遮罩层 | +| `--color-theme-scrollbar` | 滚动条 | +| `--color-theme-code-text` | 行内代码和代码块文字 | +| `--color-theme-code-background` | 行内代码背景 | +| `--color-theme-caret` | 打字效果动态光标 | 派生颜色使用 CSS `color-mix()`. 自定义配色通常只需要设置背景色, 主文本色和基础强调色; 相同语义在所有配色中保持一致, 只有确实需要不同视觉层级时才覆盖其他语义变量. @@ -310,7 +304,7 @@ PJAX 默认关闭, 开启后站内 `a[data-pjax]` 链接会更新以下区域: - `.content` - `.ex-pjax` -预留了一个 `.ex-pjax` 类名, 可以通过将注入的标签设置 `class="ex-pjax"` 来使用 PJAX, 也可以直接使用 `data-pjax` 属性 +`a[data-pjax]` 用于触发 PJAX 导航. `.ex-pjax` 是额外的内容替换区域, 需要确保当前页面和目标页面都存在对应元素. ```html @@ -319,20 +313,11 @@ PJAX 默认关闭, 开启后站内 `a[data-pjax]` 链接会更新以下区域: ``` -OR: - -```html - -