← All templates

终端会话 <Terminal />

左侧一个深色终端窗口,命令依次打出,每条带编号;右侧按编号解释每条命令说明了什么。

Template and style descriptions are currently available in Chinese only.

Group
操作 · 要敲的几条命令
Component
Terminal · #terminal
Interaction
命令按顺序逐字打出,输出随后淡入,最后一行光标闪烁。悬停右侧注释时编号变为强调色。

Good for

  • 3–4 条互相独立、但都要在终端里敲的命令
  • 想让听众看到“到底敲什么”,并知道每条为什么要敲

Avoid when

  • 命令有先后依赖、构成一个流程:用 StepTrack
  • 需要逐项勾选确认:用 Checklist
  • 没有真实命令:不要编造输出

Content limits

1steps 3–4 条;cmd ≤ 44 个字符,只写 ASCII(中文会让打字动画错位)
2out 0–3 行,每行 ≤ 48 个字符;只写文档里出现过的输出或注释(# 开头),不要编造
3note ≤ 34 字
4window ≤ 24 个字符,例如 root@aurora: ~

Fields

FieldType
kicker · requiredstring标题上方的小节名,2–8 字
title · requiredstring | string[]页面标题;传数组可手动断行,每项一行
leadstring一到两句导语,≤ 60 字
sourcestring事实出处;页面上有任何数据或事实时必填
hintReactNode页眉中间的操作提示,可用 <kbd>
window · requiredstring窗口标题
promptstring提示符,默认 #
steps · required{ cmd, out?, note }[]命令、输出与右侧解释

Example

<Terminal
  kicker="新命令"
  title="升级之后,换掉几个老习惯"
  window="root@aurora: ~"
  steps={[
    { cmd: 'apt install wtmpdb libpam-wtmpdb', note: 'last 由 wtmpdb 替代,装上 PAM 模块后才会记录登录。' },
    { cmd: 'lslogins --failed', note: '查看失败的登录尝试,作用与过去的 lastb 相近。' },
    { cmd: 'ssh-keygen -t ed25519', note: 'OpenSSH 9.8p1 起不再支持 DSA 密钥。' },
  ]}
  source="aurora 发行说明 §5.1.8 · §5.1.9"
/>