本文档详细介绍 Clarity 主题中所有自定义内容组件的使用方法。
使用这些组件需要安装 Markdown / HTML 内容块 插件,并将组件代码写入 HTML 编辑块中。
Alert 提示框
用于展示重要信息提醒,支持 5 种类型和卡片样式。
基本语法
参数说明
类型对照表
使用示例
示例 1:基本提示
示例 2:警告信息
示例 3:自定义标题
示例 4:带卡片样式的错误提示
示例 5:问题提示
Tab 标签页
用于在多个内容面板之间切换展示。
基本语法
参数说明
使用示例
示例 1:基本用法
示例 2:居中显示,默认第二个
示例 3:复杂内容
Copy 复制命令
用于展示可一键复制的命令行代码。
基本语法
或行内写法:
参数说明
使用示例
示例 1:基本命令
效果:$ npm install [复制按钮]
示例 2:自定义提示符
效果:> pip install halo [复制按钮]
示例 3:无提示符
效果:https://github.com/acanyo/theme-clarity [复制按钮]
示例 4:多条命令组合
示例 5:使用井号提示符(root 权限)
Folding 折叠面板
用于隐藏/展示次要内容,节省页面空间。
基本语法
参数说明
使用示例
示例 1:基本折叠
示例 2:默认展开
示例 3:代码折叠
示例 4:嵌套折叠
Tip 悬浮提示
为文本添加鼠标悬浮时显示的提示信息。
基本语法
参数说明
使用示例
示例 1:术语解释
效果:CSS(虚线下划线)悬浮显示 "Cascading Style Sheets,层叠样式表"
示例 2:缩写说明
示例 3:操作提示
示例 4:多个提示
Blur 模糊遮罩
隐藏敏感内容,鼠标悬浮时显示。
基本语法
参数说明
无参数,直接包裹需要模糊的内容即可。
使用示例
示例 1:隐藏答案
示例 2:剧透警告
示例 3:敏感信息
示例 4:配合其他元素
Timeline 时间线
用于展示时间轴形式的事件列表。
基本语法
参数说明
使用示例
示例 1:版本更新记录
示例 2:项目进度
示例 3:个人经历
Quote 引用块
用于展示大段引用文本,带装饰性引号图标。
基本语法
参数说明
使用示例
示例 1:名人名言
示例 2:自定义图标
示例 3:诗歌引用
示例 4:产品宣言
Chat 聊天对话
用于展示对话形式的内容,如聊天记录、FAQ 等。
基本语法
参数说明
使用示例
示例 1:简单对话
示例 2:技术讨论
示例 3:FAQ 形式
Key 键盘按键
用于展示键盘快捷键,自动适配 Mac/Windows 显示。
基本语法
参数说明
平台自适应
组件会自动检测用户系统,显示对应的按键符号:
使用示例
示例 1:搜索快捷键
效果(Mac):按 ⌘K 打开搜索框。 效果(Win):按 Ctrl+K 打开搜索框。
示例 2:组合键
示例 3:带 Shift 的组合键
示例 4:自定义文本
示例 5:完整快捷键说明
CardList 卡片列表
将普通列表转换为卡片网格布局。
基本语法
参数说明
无参数,自动将内部的 <ul> 或 <ol> 转换为卡片网格。
使用示例
示例 1:功能列表
示例 2:工具推荐
Pic 图片展示
带标题的图片展示组件。
基本语法
参数说明
使用示例
示例 1:基本图片
示例 2:指定尺寸
示例 3:响应式宽度
示例 4:无说明
Progress 进度条
用于展示进度或完成度。
基本语法
参数说明
使用示例
示例 1:基本进度
效果:显示 75% 的进度条
示例 2:带标签
示例 3:自定义颜色
示例 4:技能展示
示例 5:自定义最大值
示例 6:隐藏百分比
EmojiClock 表情时钟
显示当前时间对应的时钟 emoji。
基本语法
参数说明
无参数,自动根据当前时间显示对应的时钟表情。
时间对照
- 🕛 12:00 | 🕧 12:30 | 🕐 1:00 | 🕜 1:30 | ...
使用示例
示例 1:文章开头
示例 2:签名
Split 分栏布局
将内容分成多列显示。
基本语法
参数说明
使用示例
示例 1:两栏对比
示例 2:三栏布局
示例 3:响应式自动列数
效果:每列最小 250px,根据屏幕宽度自动调整列数
Stepper 步骤条
用于展示流程步骤。
基本语法
参数说明
使用示例
示例 1:安装流程
示例 2:开发流程
示例 3:使用教程
Note 便签
仿便利贴样式的内容展示。
基本语法
参数说明
颜色效果
使用示例
示例 1:默认黄色便签
示例 2:绿色便签
示例 3:蓝色便签(向右倾斜)
示例 4:粉色便签
示例 5:紫色便签
示例 6:多个便签组合
组合使用示例
示例 1:功能介绍页面
示例 2:技术文档
注意事项
- HTML 模式:在 Halo 编辑器中使用这些组件时,需要切换到 HTML/源码模式
- 空格问题:标签属性值中避免多余空格
- 嵌套规则:部分组件支持嵌套,但不要过度嵌套
- 性能考虑:单页面组件数量建议不超过 50 个
- 兼容性:组件基于 Preact 渲染,需要 JavaScript 支持
问题反馈
如遇问题,请通过以下渠道反馈:
- GitHub Issues: https://github.com/acanyo/theme-clarity/issues
- QQ 群: 766203360