G6 icon indicating copy to clipboard operation
G6 copied to clipboard

feat(doc-pipeline): add scripts to generate element api docs

Open yvonneyx opened this issue 1 year ago • 2 comments

  • [ ] node
  • [x] edge
  • [ ] combo

Edge:子目录包括 API 实例方法、基础样式配置、元素样式配置。

截图示例:

image image image image

yvonneyx avatar Apr 26 '24 10:04 yvonneyx

元素实例方法不需要透出,仅透出配置项就好了

Aarebecca avatar Apr 26 '24 10:04 Aarebecca

感觉后面 G2 也可以采用这一套了~

hustcc avatar Apr 26 '24 14:04 hustcc

  1. 像 labelBackground{RectStyleProps} 这类标题,改为 Prefix<RectStyleProps, ‘label’> 的格式
  • 考虑将内部 PrefixObject 重命名为 Prefix
  • 泛型顺序改为: prefix, type

“继承自” 用 ::: ::: 装饰快包一下,额外添加一行,关于 Prefix<RectStyleProps, ‘label’> 的描述说明文档的跳转

  1. context 添加 @internal 标记,不导出
  2. collapsed{Xxx} 属性改为 BaseStyleProps
  3. 标记函数重载

yvonneyx avatar Apr 28 '24 11:04 yvonneyx