← All templates

常见问题 <Faq />

两列问答,每题左侧一个衬线体编号 Q1–Q6,问题加粗,下面一到两句回答,可附一个等宽标签。

Template and style descriptions are currently available in Chinese only.

Group
答疑 · 听众最常问的问题
Component
Faq · #faq
Interaction
问答依次淡入;悬停时编号变为强调色并上移。

Good for

  • 升级、上线、采购前常被问到的 4–6 个问题
  • 每个问题都能用一两句话回答

Avoid when

  • 回答需要一整页解释:单独成页
  • 其实是在核查说法真假:用 ClaimCards

Content limits

1items 4 或 6 个
2q ≤ 24 字;a ≤ 56 字
3tag ≤ 24 个字符:命令、章节号或参数

Fields

FieldType
kicker · requiredstring标题上方的小节名,2–8 字
title · requiredstring | string[]页面标题;传数组可手动断行,每项一行
leadstring一到两句导语,≤ 60 字
sourcestring事实出处;页面上有任何数据或事实时必填
hintReactNode页眉中间的操作提示,可用 <kbd>
items · required{ q, a, tag? }[]问答

Example

<Faq
  kicker="常见问题"
  title="升级前常被问到的六件事"
  items={[
    { q: '能跳过版本直接升级吗?', a: '不能。只支持从 Lumen 12 升级。', tag: '§4.2.1' },
    { q: '/boot 要留多大?', a: '分区至少 768 MB,并留出约 300 MB 空闲空间。', tag: '§5.1.5' },
  ]}
  source="aurora 发行说明 §4 · §5"
/>