IssueHuntantvis/G6
The issue has been closed
[Docs]: 改造文档「插件 - 内置插件 - Minimap 小地图」 #6889
yvonneyx posted onGitHub
任务介绍
此 ISSUE 为 AntV 开源共建计划（AntV Open Source Contribution Plan，简称 AntV OSCP）Phase3 - 文档季的任务 ISSUE，欢迎社区开发者参与共建~
This ISSUE is one of the tasks of the AntV Open Source Contribution Plan (referred to as AntV OSCP) Pharse3 - Season of Docs . Welcome to join us in building it together!
- For more tasks, you can check the GitHub Project - 2025 AntV OSCP Season of Docs.
改造文档「插件 - 内置插件 - Minimap 小地图」
任务介绍
- 任务名称：改造 插件 - 内置插件 - Minimap 小地图 文档
- 技术方向：g6 / docs
- 任务难度：进阶 🌟🌟
- 可获得积分：30分
详细要求
- 文档规范：
- 参考示例：
- 文档结构：「Minimap」部分的文档至少应该包括 概述、使用场景、配置项，示例代码 几个部分。
- 内容规范：
- 属性表格需要包含【属性】【描述】【类型】【默认值】【必选】列，所有的配置项包括绘图属性需要罗列完整。
- 复杂类型单独解释说明
- 必要时可配上示意图
能力要求
- 对 G6 有一定了解，能阅读 G6 源码，编写示例。执行路径
1. 认领任务
选择感兴趣的且没有 Assignee 的任务，按格式回复，该任务 assign 给你后即为成功认领~
- 认领回复格式：【@GitHub ID + Give it to me】
- eg：【@yvonnyx Give it to me】
2. 做任务
- clone g6 代码
git clone https://github.com/antvis/G6.git- 拉取所有线上分支
git fetch- 切换到 v5 分支
git checkout v5- 安装依赖
pnpm install- 进入 site 包
cd packages/site- 本地启动 site 站点
pnpm run dev- 优化文档并预览效果
- 文档位于
packages/site/docs/manual/plugin/build-in/Minimap.zh.md - 代码实现
packages/g6/src/plugins/minimap
3. 提交 PR
请保证文档语意通顺、格式正确、代码示例完整且能够正确编译，否则该 PR 将不会被 review 和 merge，此 issue 将被重新释放。
- 提交 Pull Request，等待 Code Review
- PR 标题参考
docs: 任务名称，如docs: 改造点击选中交互文档，并关联OSCP标签，以便快速进入 PR review 阶段。 - PR 与对应任务 ISSUE 进行关联，方式：在 PR 正文中，通过
- Fixed: #任务 ISSUE 号即可实现关联，eg：
- 根据（多次） Code Review 建议修改
3 等待合并入 v5 分支后，积分生效