Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: optimize api docs #6813

Merged
merged 8 commits into from
Mar 3, 2025
Merged

docs: optimize api docs #6813

merged 8 commits into from
Mar 3, 2025

Conversation

yvonneyx
Copy link
Contributor

@yvonneyx yvonneyx commented Feb 28, 2025

  • 正式下线脚本自动生成文档,改用 git 管理
  • 添加交互、插件、数据处理、元素 API 文档,所有类型定义在同一文档中说明,不再使用外链
  • 根据 2 月份用户反馈完善文档
image image

// ... 其他配置项
data: {
// 初始数据
nodes: [{ id: 'start', data: { label: 'Hello G6!' } }],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

label 应该在 style 里吧,或者配置 node.labelText: (d)=>d.label

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这只是数据

@hustcc
Copy link
Member

hustcc commented Feb 28, 2025

api 文档没有 matkdown 内容吗?

@yvonneyx yvonneyx merged commit d48eb31 into v5 Mar 3, 2025
1 check passed
@yvonneyx yvonneyx deleted the docs/options branch March 3, 2025 06:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants