diff --git a/README.md b/README.md index 5f92ddc..fd724dc 100644 --- a/README.md +++ b/README.md @@ -1,163 +1,332 @@ -# Terminal +# Terminal-EZ -scheme +一款简洁, 复古的 Terminal 风格 Halo 主题 -前往: https://erzbir.com 查看 +![配色预览](https://raw.githubusercontent.com/Erzbir/halo-theme-terminal/refs/heads/main/preview/scheme.png) ## 功能 -1. PJAX -2. 样式自定义 -3. 配色切换 -4. 深色/浅色模式 -5. 页面自定义 -6. 文章目录 -7. 社交资料 -8. 子菜单 -9. 像素化 +- Terminal 风格的响应式页面布局 +- 深色, 浅色和跟随系统 3 种默认模式 +- 12 套内置配色 +- 访客配色选择器 +- 常规图标和像素图标切换 +- JetBrains Mono, 系统字体, 自定义字体和内置像素字体 +- 首页公告打字效果 +- 文章目录和目录展开状态配置 +- 文章标签, 置顶标记和上一篇/下一篇导航 +- Halo 评论组件适配 +- Halo 搜索组件适配 +- PJAX 页面切换 +- 多级菜单 +- 社交资料和 RSS +- ICP 备案和公安备案信息 +- 首页, 文章, 独立页面, 归档, 分类, 标签, 友链和错误页模板 +- 瞬间, 朋友圈和项目作品集页面模板 +- 英文, 简体中文, 繁体中文和西班牙文界面文本 -## 关于自定义 CSS +## 页面和集成 -目前只有原始 CSS 输入, 在样式设置中可以填入原始 CSS, 主题会直接将这段 CSS 插入到 head +| 页面或功能 | 模板或条件 | +|-----------|------------------------------------------------------------------------| +| 首页 | `templates/index.html` | +| 文章页 | `templates/post.html` | +| 独立页面 | `templates/page.html` | +| 归档页 | `templates/archives.html` | +| 分类列表和分类详情 | `templates/categories.html`, `templates/category.html` | +| 标签列表和标签详情 | `templates/tags.html`, `templates/tag.html` | +| 友链页 | `templates/links.html` | +| 朋友圈 | `templates/friends.html`, 需要朋友圈插件 | +| 瞬间 | `templates/moments.html`, 需要瞬间插件 | +| 项目作品集 | `templates/portfolio.html`, `templates/portfolio-detail.html`, 需要作品集插件 | +| 搜索 | 启用搜索组件时页头显示搜索按钮 | +| 评论 | 启用评论插件并开启评论功能时显示评论组件 | +| 错误页 | 提供 `404`, `5xx` 和通用错误模板 | -### 新增自定义主题配色 +## 主题设置 -比如这里增加一个名字叫 `default` 的配色: +### 基本设置 + +| 设置 | 配置名 | 说明 | +|---------|---------------------|----------------------| +| Logo 文本 | `basic.logo` | 留空时使用 Halo 站点标题 | +| 启用 PJAX | `basic.pjax_enable` | 默认关闭, 开启后站内链接只更新主要内容 | + +### 布局和样式 + +| 设置 | 配置名 | 说明 | +|----------|--------------------------------------------------------|---------------------------------------------------| +| 全屏布局 | `style.fullscreen_layout` | 隐藏两侧占位区域, 正文使用全部可用宽度 | +| 正文最大宽度 | `style.max_width` | 接受 `960px`, `80vw` 等 CSS 长度 | +| 正文内边距 | `style.content_padding` | 同时控制桌面端和移动端正文内边距 | +| 正文媒体最大宽度 | `style.media_max_width` | 全屏布局中控制图片, 视频和 `figure` 宽度 | +| 表格铺满正文 | `style.table_full_width` | 让正文中的表格宽度为 `100%` | +| 基础字体大小 | `style.font_size` | 接受 `16px`, `1rem` 等 CSS 长度 | +| 使用系统字体 | `style.system_font_enable` | 使用访问者的 `system-ui` 字体 | +| 默认像素风格 | `style.pixel_style` | 使用像素字体和像素图标 | +| 自定义字体 | `style.custom_font_enable` | 上传字体文件并填写字体内部名称 | +| 无序列表标记 | `style.list_marker` | 可选 `-`, `*`, `+`, `>` 或默认标记 | +| 通用边线 | `style.border_width`, `style.border_style` | 控制通用边线宽度和样式 | +| 表格边线 | `style.table_border_width`, `style.table_border_style` | 控制表格边线宽度和样式 | +| 标题分隔线 | `style.title_divider_style` | 可选 `solid`, `dashed`, `dotted`, `double` 或 `none` | +| 时间格式 | `style.time_style` | 支持预设格式或 Java 时间格式字符串 | +| 自定义 CSS | `style.custom` | 将 CSS 写入页面 `` 中的 `