首页功能配置
本主题基于 Rspress V2 的 HomeFeature 组件,支持灵活配置首页功能展示区域。
基础配置
在 docs/index.md 文件的 frontmatter 中配置 features:
Feature 属性
每个 feature 支持以下属性:
图标格式
icon 属性支持以下格式:
- Emoji:
'🚀' - HTML 字符串:
'<span class="icon">...</span>' - SVG 字符串:
'<svg>...</svg>' - 图片 URL:
'/icons/feature.svg'或'https://example.com/icon.png'
布局控制(span 属性)
Rspress 使用 12 列网格系统,通过 span 属性控制每个 feature 占据的列数:
示例:每行显示 2 个功能
示例:每行显示 4 个功能
示例:混合布局
可以为不同功能设置不同的 span 值,创建不对称布局:
链接功能(link 属性)
添加 link 属性可以让 feature 卡片变成可点击的链接:
内部链接
外部链接
链接格式建议
- 目录/分类页面:建议加斜杠,如
/guide/、/guide/getting-started/ - 具体文档页面:可不加斜杠,如
/guide/copyright或/guide/copyright.md - 外部链接:保持原样,如
https://github.com/...
完整示例
响应式布局
Rspress 会自动处理响应式布局:
- 桌面端(> 960px):按照
span属性显示 - 平板端(≤ 960px):自动调整为 2 列
- 手机端(≤ 640px):自动调整为 1 列
无需额外配置,系统会自动适配不同屏幕尺寸。