Rainbond文档中心
Rainbond文档规范说明 编辑此页面

文档规范正在完善中

内容要求

写作前请认真规划自己的写作内容,想清楚自己要写什么,怎么写,列出提纲,再根据提纲逐步丰富内容。

Rainbond 中文档分为 概念性文档操作指引性文档最佳实践性文档 不同的文档类型。书写文档请明确文档的类型,根据不同的类型需要达成的效果进行文章内容的确定。 其中操作指引性文档 和 *最佳实践性文档*最好配属对应的操作指导视频。文章中涉及操作过程的不能仅使用截图或 GIF 动图来说明,必须使用文字描述清楚。

排版规范

  • 所有的英文跟中文之间要有一个空格;
  • 文档支持引用 b 站视频,引用参考方式如下:
 <bibili-video src="//player.bilibili.com/player.html?aid=668179307&bvid=BV1da4y1i7tQ&cid=190877377&page=1" href="https://www.bilibili.com/video/BV1da4y1i7tQ/" title="应用复制与流量控制演示">
  • 文档引入图片时请使用如下方式:
<image src="https://grstatic.oss-cn-shanghai.aliyuncs.com/docs/5.2/connection.png" title="组件间通信结构图" width="100%">