docs: optimize api docs #6813
Open
docs: optimize api docs #6813
+12,198
−852
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
yvonneyx
commented
Feb 28, 2025
•
yvonneyx
commented
- 正式下线脚本自动生成文档，改用 git 管理
- 添加交互、插件、数据处理、元素 API 文档，所有类型定义在同一文档中说明，不再使用外链
- 根据 2 月份用户反馈完善文档
Aarebecca
reviewed
Feb 28, 2025
| // 方式二：传入渲染器实例 | ||
| renderer: new SVGRenderer(), | ||
| // 方式三：动态设置 | ||
| renderer: () => new SVGRenderer(), |
Aarebecca
reviewed
Feb 28, 2025
| @@ -60,17 +31,126 @@ Graph 类接收一个实例化参数对象，称之为**配置项**(Options， | |||
| import { Graph } from '@antv/g6'; | |||
|
|
|||
| const graph = new Graph({ | |||
| container: 'container', | |||
| width: 800, | |||
| container: 'container', // 指定容器 | |||
Aarebecca
reviewed
Feb 28, 2025
| // ... 其他配置项 | ||
| data: { | ||
| // 初始数据 | ||
| nodes: [{ id: 'start', data: { label: 'Hello G6!' } }], |
There was a problem hiding this comment.
label 应该在 style 里吧，或者配置 node.labelText: (d)=>d.label
Aarebecca
approved these changes
Feb 28, 2025
|
api 文档没有 matkdown 内容吗？ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.