内容组件示例

一篇把编辑器里所有内容块都用一遍的示例文章,写文章前可以照这个格式来。

这篇文章本身没有实际内容,纯粹是给正文里能用的所有内容块各来一遍示范,方便写文章时对照格式、或者直接复制对应的写法。

标题与正文

段落里可以有加粗链接、以及行内 代码 这三种行内格式,别的行内标签排版规范里不允许用。

这是一个小标题

大标题(h2)会自动进右侧「本页目录」,小标题(h3)不会——用来在一个大章节内部再分一层,比如这一段就是「标题与正文」底下的一个小节。

提示条

信息:普通提示、补充说明,用这个颜色。

成功:推荐做法、正确示范、已完成状态。

注意:需要留心的坑、待办事项、慎用的做法。

警告:不要这样做、已废弃、错误示范。

列表

无序列表

  • 适合并列、不分先后的要点
  • 每一项独立成句,不用加句号
  • 项目不宜太长,太长考虑拆成小标题+段落

有序列表

  1. 适合有先后顺序的步骤
  2. 比如安装流程、操作步骤这类
  3. 跟「编号步骤」组件的区别:这个更轻量,编号步骤视觉更醒目

编号步骤

操作教程、安装流程这类需要强调先后顺序、每步又有较多说明文字时用这个,比有序列表更醒目:

1
打开 Assets 面板
按快捷键 Option + 2(Mac)或点击左侧工具栏的资源图标,切换到 Assets 标签页。
2
启用团队组件库
点击 Assets 面板右上角的书本图标 → Libraries,在弹窗中找到「视频组 · 组件库」,点击开关启用。启用后刷新页面生效。
3
搜索并拖入组件
在搜索框输入组件名(如 CardButton/Primary),找到目标组件后直接拖入画布。这会创建一个组件实例,不会修改主组件。

代码块

贴命令行、配置片段、代码示例用这个:

cd cwlkit-site
node tools/create-article.mjs <id> <section> <文件>

表格

列属性/参数说明这类结构化信息用表格:

块类型说明
提示条四色语义状态,信息/成功/注意/警告
编号步骤比有序列表更醒目,适合教程类多步操作
图片可拖拽缩放宽度,图注选填
附件任意文件下载,限制 20MB

图片

截图/配图放在对应位置,图注选填:

示例图注——写清楚这张图是什么
示例图注——写清楚这张图是什么

附件

插件包、交接文档这类可下载资源用附件块,卡片会显示文件名和大小:

示例附件.zip253 B下载