UI 组件文档规范
组件的编写需要按照一定的书写规则,以便于 Bot 能正常识别文档内容,并自动生成到汇总页面,或者自动同步到插件中。
预览*
预览块是必须的。标题为 预览
或 Preview
,且为 h2
二级标签。
其下内容需要至少包括一张预览图,可以是图片或 gif。预览图可以有多张,主要的预览图命名要求必须是 preview-main
基础使用*
组件需要有基础的使用实例,此项是必须的。标题为 基础使用
或 Basic Usage
,且为 h2
二级标签。
其下内容应要展示组件见常用的使用方法,可以编写一段代码块和说明,让读者尽快的上手
详细说明
当组件比较复杂,无法在基础使用中说明清楚,可以补上说明,此项非必须。标题为 详细说明
或 Detail
,且为 h2
二级标签。
Snippest
如果你的组件是会被高频使用的,可以考虑把该组件加入便捷代码块中即 Snippest,非必须。标题为或 Snippest
,且为 h2
二级标签。
其下内容需要包含一个代码块,里面的内容会被视作 vscode 的 snippest 段自动补充到客户端插件中,所以请确保语法是正确的。